docs: Adding some initial documentation. Based off the prjxray docs. Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..f7a3e54 --- /dev/null +++ b/docs/.gitignore
@@ -0,0 +1,2 @@ +_build +tests/*.md
diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..4881ff6 --- /dev/null +++ b/docs/Makefile
@@ -0,0 +1,56 @@ +# Minimal makefile for Sphinx documentation +# + +MAKEDIR := $(dir $(lastword $(MAKEFILE_LIST))) + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = [ -e venv/bin/activate ] && source venv/bin/activate; sphinx-build +SPHINXAUTOBUILD = [ -e venv/bin/activate ] && source venv/bin/activate; sphinx-autobuild +SPHINXPROJ = SymbiFlowV2X +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +livehtml: + @$(SPHINXAUTOBUILD) -b html --ignore \*.swp --ignore \*~ $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" + +.PHONY: help livehtml Makefile + +venv: + rm -rf venv + virtualenv --python=python3 venv + source venv/bin/activate; pip install -r requirements.txt + +.PHONY: venv + +# Update fuzzer / minitest markdown links. +tests-links: + @mkdir -p $(MAKEDIR)/tests + @cd $(MAKEDIR)/tests && rm -f *.md + @cd $(MAKEDIR)/tests && \ + for i in ../../tests/*; do \ + n=$$(basename $$i | sed -e's/^[0-9][0-9][0-9]-//'); \ + if [ ! -d $$i ]; then \ + continue; \ + fi; \ + if [ -e $$i/README.md ]; then \ + echo "Linking $$i/README.md"; \ + ln -s $$i/README.md $${n}.md; \ + else \ + echo "Missing $$i/README.md"; \ + fi; \ + done + +links: tests-links + @true + +.PHONY: tests-links links + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile links + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_static/.keepme b/docs/_static/.keepme new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/_static/.keepme
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..cc769b8 --- /dev/null +++ b/docs/conf.py
@@ -0,0 +1,266 @@ +# -*- coding: utf-8 -*- +# +# SymbiFlow V2X documentation build configuration file, created by +# sphinx-quickstart on Mon Feb 5 11:04:37 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import re + +# Markdown support +import recommonmark + +# 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('.')) +from markdown_code_symlinks import LinkParser, MarkdownSymlinksDomain + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.imgmath', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', + 'sphinx_markdown_tables', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = ['.rst', '.md'] +source_parsers = { + '.md': 'markdown_code_symlinks.LinkParser', +} + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'SymbiFlow Verilog to XML (V2X)' +copyright = u'2018, SymbiFlow Team' +author = u'SymbiFlow Team' + +# Enable github links when not on readthedocs +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +if not on_rtd: + html_context = { + "display_github": True, # Integrate GitHub + "github_user": "symbiflow", # Username + "github_repo": "python-symbiflow-v2x", # Repo name + "github_version": "master", # Version + "conf_py_path": "/doc/", + } +else: + docs_dir = os.path.abspath(os.path.dirname(__file__)) + print("Docs dir is:", docs_dir) + import subprocess + subprocess.call('git fetch origin --unshallow', cwd=docs_dir, shell=True) + subprocess.check_call('git fetch origin --tags', cwd=docs_dir, shell=True) + subprocess.check_call('make links', cwd=docs_dir, shell=True) + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = re.sub('^v', '', os.popen('git describe ').read().strip()) +# The short X.Y version. +version = release + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'venv', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'default' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + +# -- 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_materialdesign_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + # Specify a list of menu in Header. + # Tuples forms: + # ('Name', 'external url or path of pages in the document', boolean, 'icon name') + # + # Third argument: + # True indicates an external link. + # False indicates path of pages in the document. + # + # Fourth argument: + # Specify the icon name. + # For details see link. + # https://material.io/icons/ + 'header_links': [ + ('Home', 'index', False, 'home'), + ("GitHub", "https://github.com/SymbiFlow/python-symbiflow-v2x", True, 'link') + ], + + # Customize css colors. + # For details see link. + # https://getmdl.io/customize/index.html + # + # Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue, + # light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo) + 'primary_color': + 'deep_purple', + # Values: Same as primary_color. (Default: pink) + 'accent_color': + 'purple', + + # Customize layout. + # For details see link. + # https://getmdl.io/components/index.html#layout-section + 'fixed_drawer': + True, + 'fixed_header': + True, + 'header_waterfall': + True, + 'header_scroll': + False, + + # Render title in header. + # Values: True, False (Default: False) + 'show_header_title': + False, + # Render title in drawer. + # Values: True, False (Default: True) + 'show_drawer_title': + True, + # Render footer. + # Values: True, False (Default: True) + 'show_footer': + True +} + +# 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 = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'symbiflow-v2x' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, 'SymbiFlowV2X.tex', u'SymbiFlow V2X Documentation', + u'SymbiFlow Team', 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'symbiflow-v2x', u'SymbiFlow V2X Documentation', [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, 'SymbiFlowV2X', u'SymbiFlow V2X Documentation', author, + 'SymbiFlowV2X', 'One line description of project.', 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + + +def setup(app): + github_code_repo = 'https://github.com/SymbiFlow/python-symbiflow-v2x/' + github_code_branch = 'blob/master/' + + docs_root_dir = os.path.realpath(os.path.dirname(__file__)) + code_root_dir = os.path.realpath(os.path.join(docs_root_dir, "..")) + + MarkdownSymlinksDomain.init_domain( + github_code_repo, github_code_branch, docs_root_dir, code_root_dir) + MarkdownSymlinksDomain.find_links() + app.add_domain(MarkdownSymlinksDomain) + app.add_config_value( + 'recommonmark_config', { + 'github_code_repo': github_code_repo, + }, True)
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..605e9e5 --- /dev/null +++ b/docs/index.rst
@@ -0,0 +1,16 @@ +.. SymbiFlow V2X documentation master file + +Welcome to SymbiFlow Verilog to XML +========================================= + +`SymbiFlow Verilog to XML`_ `V2X`_ . + +.. _SymbiFlow Verilog to XML: https://github.com/SymbiFlow/python-symbiflow-v2x +.. _V2X: http://symbiflow-v2x.readthedocs.io/ + +.. toctree:: + :maxdepth: 2 + :glob: + :caption: Tests + + tests/**
diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..ec9e872 --- /dev/null +++ b/docs/requirements.txt
@@ -0,0 +1,13 @@ +sphinx_materialdesign_theme + +docutils +sphinx +sphinx-autobuild + +breathe +recommonmark +sphinx-markdown-tables +sphinxcontrib-napoleon + +# Markdown cross-reference solver library +git+https://github.com/SymbiFlow/sphinxcontrib-markdown-symlinks