Merge pull request #15 from tcal-x/rtd

Sphinx-material, readthedocs, w/ markdown extension.

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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,4 @@
+Sphinx==3.3.0
+sphinx-material==0.0.32
+sphinx-tabs==1.3.0
+sphinx-jinja==1.1.1

docs/source/.gitattributes

@@ -0,0 +1,3 @@
+*.png binary
+*.gif binary
+*.jpg binary

docs/source/.gitignore

@@ -0,0 +1 @@
+_build

docs/source/_templates/example.jinja

@@ -0,0 +1,51 @@
+{% for block in blocks -%}
+
+{% if block.type == 'literal_block' %}
+
+{% if not block.start_group and not block.in_group %}
+.. code-block:: {% if 'bash' in block.classes %}bash{% endif %}
+
+   {% for line in block.text -%}
+   {{ line }}
+   {% endfor %}
+
+{% elif block.start_group %}
+.. tabs::
+
+   .. group-tab:: {{ block.name }}
+
+      .. code-block:: bash
+
+         {% for line in block.text -%}
+         {{ line }}
+         {% endfor %}
+{% elif block.in_group %}
+   .. group-tab:: {{ block.name }}
+
+      .. code-block:: bash
+
+         {% for line in block.text -%}
+         {{ line }}
+         {% endfor %}
+
+{% endif %}
+
+{% elif block.type == 'image' %}
+.. image:: {{ block.uri }}
+   :align: {{ block.align }}
+   :width: {{ block.width }}
+
+{% elif block.type == 'note' %}
+.. note::
+
+   {% for line in block.text -%}
+   {{ line }}
+   {% endfor %}
+
+
+{% else %}
+{{ block.text }}
+
+{% endif %}
+
+{% endfor %}

docs/source/conf.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020  The SymbiFlow Authors.
+# Copyright (C) 2021  The CFU-Playground Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# 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('.'))
+
+from recommonmark.parser import CommonMarkParser
+
+# -- Project information -----------------------------------------------------
+
+project = u'CFU-Playground'
+authors = u'The CFU-Playground Authors'
+copyright = authors + u', 2020'
+
+# -- 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.
+extensions = [
+    'sphinx_tabs.tabs',
+    'sphinxcontrib.jinja',
+    'recommonmark',
+]
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+source_suffix = ['.rst', '.md']
+
+
+# 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_show_sourcelink = True
+html_sidebars = {
+    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
+}
+
+html_theme = 'sphinx_material'
+html_theme_options = {
+    'nav_title': project,
+    'color_primary': 'orange',
+    'color_accent': 'gray',
+    'repo_name': "google/CFU-Playground",
+    'repo_url': 'https://github.com/google/CFU-Playground',
+    'globaltoc_depth': 2,
+    'globaltoc_collapse': 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']
+
+
+# -- Collect READMEs from examples --------------------------------------------
+#
+#from collect_readmes import full_name_lut, families, fill_context
+#
+#jinja_contexts = {}
+#top_dir = os.path.join(os.path.dirname(__file__), '..')
+#for family in families:
+#    examples = os.scandir(os.path.join(top_dir, family))
+#    for example in examples:
+#        if example.is_dir():
+#
+#            # get README
+#            path = os.path.join(top_dir, family, example, 'README.rst')
+#
+#            # skip if file does not exist
+#            if not os.path.isfile(path):
+#                continue
+#
+#            with open(path) as f:
+#                text = f.read()
+#
+#            key = '_'.join((family, example.name))
+#            jinja_contexts[key] = {'blocks': fill_context(text)}

docs/source/index.rst

@@ -0,0 +1,22 @@
+.. CFU-Playground documentation master file, created by
+   sphinx-quickstart on Tue Mar  9 18:35:27 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to CFU-Playground's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   md_example
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/md_example.md

@@ -0,0 +1,35 @@
+
+# Markdown Example Title
+
+This file is written using Markdown.
+
+## Section Header
+
+Let's try some code:
+
+```python
+
+    def __init__(self, width=32):
+        super().__init__()
+        self.value = Signal(width)
+        self.set = Signal()
+
+    def elab(self, m):
+        m.d.sync += self.set.eq(0)
+        with m.If(self.start):
+            m.d.sync += self.value.eq(self.in0),
+            m.d.sync += self.set.eq(1),
+            m.d.comb += self.output.eq(self.value)
+            m.d.comb += self.done.eq(1)
+
+
+```
+
+### Subsection Header
+
+We have a list.
+
+* item1
+* item2
+* item3
+

docs/source/requirements.txt

@@ -0,0 +1,4 @@
+Sphinx==3.3.0
+sphinx-material==0.0.32
+sphinx-tabs==1.3.0
+sphinx-jinja==1.1.1