From d0fb39ddbdb5816c25870ca4db36985a70799a81 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Tue, 13 Apr 2021 10:06:44 -0700 Subject: Adding Sphinx documentation generation for the docs. Signed-off-by: Tim 'mithro' Ansell --- .gitignore | 120 ++++++++++++++++++++ .readthedocs.yml | 16 +++ docs/Makefile | 65 +++++++++++ docs/_static/.keepme | 0 docs/bel_and_site_design.md | 2 +- docs/conf.py | 268 ++++++++++++++++++++++++++++++++++++++++++++ docs/device_resources.md | 2 +- docs/environment.yml | 16 +++ docs/index.rst | 18 +++ docs/pseudo_cells.md | 2 +- docs/requirements.txt | 10 ++ 11 files changed, 516 insertions(+), 3 deletions(-) create mode 100644 .gitignore create mode 100644 .readthedocs.yml create mode 100644 docs/Makefile create mode 100644 docs/_static/.keepme create mode 100644 docs/conf.py create mode 100644 docs/environment.yml create mode 100644 docs/index.rst create mode 100644 docs/requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..96935f2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,120 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +env/ +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# Emacs temporary files +*~ diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..93b8e44 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,16 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +formats: + - htmlzip + +conda: + environment: docs/environment.yml diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..01ff6c0 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,65 @@ +# Copyright (C) 2017-2020 The SymbiFlow Authors. +# +# Use of this source code is governed by a ISC-style +# license that can be found in the LICENSE file or at +# https://opensource.org/licenses/ISC +# +# SPDX-License-Identifier: ISC +# Minimal makefile for Sphinx documentation + + +SHELL = /bin/bash +MAKEDIR := $(dir $(lastword $(MAKEFILE_LIST))) + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = [ -e env/bin/activate ] && source env/bin/activate; sphinx-build +SPHINXAUTOBUILD = [ -e env/bin/activate ] && source env/bin/activate; sphinx-autobuild +SPHINXPROJ = SymbiFlowFIF +SOURCEDIR = . +BUILDDIR = _build +OSFLAG = +UNAME_S := $(shell uname -s) +ifneq (, $(findstring Linux, $(UNAME_S))) + OSFLAG := Linux +endif +ifeq ($(UNAME_S), Darwin) + OSFLAG := MacOSX +endif +ifneq (, $(findstring Cygwin, $(UNAME_S))) + OSFLAG := Linux +endif +ifneq (, $(findstring MINGW, $(UNAME_S))) + OSFLAG := Linux +endif + + +# 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 + + +env/Miniconda3-latest-$(OSFLAG)-x86_64.sh: + mkdir env + wget https://repo.anaconda.com/miniconda/Miniconda3-latest-$(OSFLAG)-x86_64.sh -O env/Miniconda3-latest-$(OSFLAG)-x86_64.sh + chmod a+x env/Miniconda3-latest-$(OSFLAG)-x86_64.sh + +env: + rm -rf env + make env/Miniconda3-latest-$(OSFLAG)-x86_64.sh + ./env/Miniconda3-latest-$(OSFLAG)-x86_64.sh -p $(PWD)/env -b -f + source env/bin/activate; conda config --system --add envs_dirs $(PWD)/env/envs + source env/bin/activate; conda config --system --add pkgs_dirs $(PWD)/env/pkgs + source env/bin/activate; conda env update --name base --file ./environment.yml + +.PHONY: env + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/.keepme b/docs/_static/.keepme new file mode 100644 index 0000000..e69de29 diff --git a/docs/bel_and_site_design.md b/docs/bel_and_site_design.md index d7db3fb..266ec0e 100644 --- a/docs/bel_and_site_design.md +++ b/docs/bel_and_site_design.md @@ -1,4 +1,4 @@ -## Cell, BEL and Site Design +# Cell, BEL and Site Design One of the key concepts within the FPGA interchange device resources is the relationship between the cell library and the device BEL and site definitions. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..5b1432c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,268 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Copyright (C) 2017-2020 The SymbiFlow Authors. +# +# Use of this source code is governed by a ISC-style +# license that can be found in the LICENSE file or at +# https://opensource.org/licenses/ISC +# +# SPDX-License-Identifier: ISC + +# 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 + +# 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('.')) + +# -- 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', + 'recommonmark', +] + +# 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'] + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'SymbiFlow FPGA Interchange Format' +copyright = u'2021, 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": "fpga-interchange-schema", # Repo name + "github_version": "master", # Version + "conf_py_path": "/docs/", + } +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) + +# 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', 'env', '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_symbiflow_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/fpga-interchange-schema", + 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 = 'fpga-interchange-schema' + +# -- 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, + 'fpga-interchange-schema.tex', + u'SymbiFlow FPGA Interchange Format 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, + 'fpga-interchange-schema', + u'SymbiFlow FPGA Interchange Format 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, + 'SymbiFlowFIFM', + u'SymbiFlow FPGA Interchange Format Documentation', + author, + 'SymbiFlowFIF', + '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): + pass diff --git a/docs/device_resources.md b/docs/device_resources.md index 8e42c44..a2671c5 100644 --- a/docs/device_resources.md +++ b/docs/device_resources.md @@ -1,4 +1,4 @@ -## Device Resources +# Device Resources The device resources schema is intended to be a complete description of an island-based FPGA design. It is made of many components, but the core diff --git a/docs/environment.yml b/docs/environment.yml new file mode 100644 index 0000000..4b74234 --- /dev/null +++ b/docs/environment.yml @@ -0,0 +1,16 @@ +name: fpga-interchange-schema-docs +channels: +- SymbiFlow +- conda-forge +- defaults +dependencies: +- python=3.7 +- pip +# ReadTheDoc dependencies +- mock +- pillow +- sphinx +- sphinx_rtd_theme +# Packages installed from PyPI +- pip: + - -r file:requirements.txt diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d8dc21e --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +Welcome to FPGA Interchange documentation! +========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + device_resources + bel_and_site_design + pseudo_cells + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/pseudo_cells.md b/docs/pseudo_cells.md index a55fc44..65b55d9 100644 --- a/docs/pseudo_cells.md +++ b/docs/pseudo_cells.md @@ -1,4 +1,4 @@ -## Pseudo Cells +# Pseudo Cells Pseudo PIPs and site pseudo PIPs are edges in the device graph that route through other sites and/or BELs. Pseudo cells are the expression of what diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..b83d251 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,10 @@ +git+https://github.com/SymbiFlow/sphinx_symbiflow_theme.git#egg=sphinx_symbiflow_theme + +docutils +sphinx +sphinx-autobuild + +breathe +recommonmark +sphinx-markdown-tables +sphinxcontrib-napoleon -- cgit v1.2.3