Add Sphinx Documentation (#6)

* Add sphinx docs

* Fix typos

* fix capitalization of symbiflow

* fix wording and add additional detail to docs

Co-authored-by: Johnny Bui <[email protected]>

Author: TypingKoala

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'FTPVL'
+copyright = '2020, Johnny Bui. Licensed under the MIT License.'
+author = 'Johnny Bui'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+
+import sphinx_rtd_theme
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx_rtd_theme'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+master_doc = 'index'

docs/images/styled_viz.png

@@ -0,0 +1,68 @@
+.. _index:
+
+===================================================
+FTPVL Documentation
+===================================================
+FPGA Tool Performance Visualization Library (FTPVL) is a library for simplifying 
+the data collection, analysis, and visualization of performance metrics for
+SymbiFlow development. Although it was made with SymbiFlow in mind, it is highly
+extensible for future integration with other software.
+
+🚀 Getting Started
+===================
+Learn how to get up and running with FTPVL.
+
+.. toctree::
+   :caption: Getting Started
+   :hidden:
+
+   intro/firststeps
+   intro/examples
+
+:doc:`intro/firststeps`
+   The first steps for using FTPVL.
+
+:doc:`intro/examples`
+   Look at some real-world examples to see FTPVL at work!
+
+
+✈ Overview
+==========
+Dive into the main features of FTPVL.
+
+.. toctree::
+   :caption: Overview
+   :hidden:
+   
+   topics/evaluation
+   topics/fetchers
+   topics/processors
+   topics/styles
+   topics/visualizers
+
+:doc:`topics/evaluation`
+   Main data structure used for manipulation.
+
+:doc:`topics/fetchers`
+   Ingest data from Hydra or a JSON dataframe.
+
+:doc:`topics/processors`
+   Perform processing on the results using a processing pipeline.
+
+:doc:`topics/styles`
+   Generate styling for custom visualizations.
+
+:doc:`topics/visualizers`
+   Visualize the processed data.
+
+
+📖 Reference
+============
+.. toctree::
+   :caption: Reference
+   :hidden:
+   
+   topics/api
+
+:doc:`topics/api`
+   Learn about the API of FTPVL.

docs/index.rst

@@ -0,0 +1,16 @@
+.. _intro-examples:
+
+========
+Examples
+========
+
+You can take a look at some other examples of FTPVL at work in Google Colab
+notebooks.
+
+- `Using HydraFetcher and Processors`_
+- `Styling Tables with SingleTableVisualizer`_
+- `Comparing Two Different Evaluations`_
+
+.. _Using HydraFetcher and Processors: https://colab.research.google.com/drive/1BIQ-iulDFpzcve7lGJPwLePJ5ETBJ6Ut?usp=sharing
+.. _Styling Tables with SingleTableVisualizer: https://colab.research.google.com/drive/1u3EnmIYnTBk-LXZhqNHt_h4aMuq-_cWq?usp=sharing
+.. _Comparing Two Different Evaluations: https://colab.research.google.com/drive/1I7InmA6210vIIwdQ7TGHE6aF_WwIm1dM?usp=sharing