SymbiFlow · kgugala · Sep 15, 2020 · Sep 8, 2020 · Sep 9, 2020 · Sep 8, 2020
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,26 @@
-__pycache__/
 build/
+env/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
 *.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
 *.egg-info/
+.installed.cfg
+*.egg
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "third_party/make-env"]
+	path = third_party/make-env
+	url = https://github.com/SymbiFlow/make-env/
diff --git a/.readthedocs.yml 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: environment.yml
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,26 @@
+language: minimal
+
+before_install:
+  - make env
+  - source env/conda/bin/activate sphinx-verilog-domain
+
+stages:
+    - name:
+        - Build
+        - Deploy
+
+jobs:
+    - stage: Build
+      name: "Build"
+      script:
+        - make build
+
+    - stage: Deploy
+      name: "PyPI"
+      before_deploy:
+        - sudo ln -sf /usr/bin/python3 /usr/bin/python
+      deploy:
+        provider: pypi
+        username: __token__
+        distributions: sdist bdist_wheel
+        skip_existing: true
diff --git a/Makefile b/Makefile
@@ -0,0 +1,35 @@
+# Copyright (C) 2020  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
+
+# The top directory where environment will be created.
+TOP_DIR := $(realpath $(dir $(lastword $(MAKEFILE_LIST))))
+
+# A pip `requirements.txt` file.
+# https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format
+REQUIREMENTS_FILE := requirements.txt
+
+# A conda `environment.yml` file.
+# https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
+ENVIRONMENT_FILE := environment.yml
+
+include third_party/make-env/conda.mk
+
+# Build the package locally
+
+build: $(CONDA_ENV_PYTHON)
+	$(IN_CONDA_ENV) python setup.py sdist bdist_wheel && twine check dist/*
+
+build-clean:
+	rm -rf env/downloads/conda-pkgs
+	rm -rf build dist *.egg-info
+	find -name *.pyc -delete
+	find -name __pycache__ -delete
+
+.PHONY: build build-clean
+
+clean:: build-clean
diff --git a/README.rst b/README.rst
@@ -1,11 +1,9 @@
-Sphinx Verilog Domain
+sphinx-verilog-domain
 =====================
 
 .. warning::
-    This extension is in development stage.
 
-.. note::
-    This extension is not a part of sphinxcontrib yet.
+    This extension is in development stage.
 
 Dependencies
 ------------
@@ -17,7 +15,7 @@ Enabling
 
 Add extension in ``conf.py``::
 
-    extensions = [ 'sphinxcontrib.verilogdomain' ]
+    extensions = [ 'sphinx_verilog_domain' ]
 
 Usage
 -----
@@ -64,7 +62,6 @@ Nesting::
 
             Reference to module ``Top1``'s port ``a``: :verilog:ref:`Top1.a`.
 
-
 Namespaces
 ^^^^^^^^^^
 
@@ -89,3 +86,12 @@ Example::
     .. verilog:port:: input inside_a_b_again;
     .. verilog:namespace::
     .. verilog:port:: input in_global_namespace;
+
+Development
+-----------
+
+To create and open the development environment with all system
+and python packages use::
+
+   make env
+   source env/conda/bin/activate sphinx-verilog-domain
diff --git a/example/Makefile → docs/Makefile b/example/Makefile → docs/Makefile
@@ -1,10 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-SPHINXOPTS    = -E -v
-SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = verilogdomain-test
+# 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
 
@@ -16,5 +16,5 @@ help:
 
 # 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)
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,5 @@
+git+https://github.com/SymbiFlow/sphinx_symbiflow_theme
+
+sphinx
+symbolator
+sphinxcontrib-verilog-diagrams
-sphinxcontrib-verilog-diagrams
+-e ../
-sphinxcontrib-verilog-diagrams
+-e ../
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,92 @@
+# 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 = 'Sphinx Verilog Domain'
+copyright = '2020, SymbiFlow Team'
+author = 'SymbiFlow Team'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- 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_verilog_domain',
+  'symbolator_sphinx',
+  'sphinxcontrib_verilog_diagrams'
+]
+
+# 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 = []
+
+
+# -- 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'
+
+# Values used for configuring Sphinx SymbiFlow Theme
+
+html_theme_options = {
+    'header_links' : [
+        ('Home', 'index', False, 'home'),
+    ],
+    # 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': 'red',
+    # Values: Same as primary_color. (Default: pink)
+    'accent_color': 'blue',
+
+    # 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']
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,20 @@
+Sphinx Verilog Domain
+=====================
+
+.. warning::
+
+   Documentation for this Sphinx extension is under development.
+   Below you can find basic tests for the extension.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tests
+
+   tests/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/example/source/index.rst → docs/source/tests/index.rst b/example/source/index.rst → docs/source/tests/index.rst
diff --git a/example/source/module.rst → docs/source/tests/module.rst b/example/source/module.rst → docs/source/tests/module.rst
diff --git a/example/source/nesting.rst → docs/source/tests/nesting.rst b/example/source/nesting.rst → docs/source/tests/nesting.rst
diff --git a/example/source/nesting2.rst → docs/source/tests/nesting2.rst b/example/source/nesting2.rst → docs/source/tests/nesting2.rst
diff --git a/example/source/parameter.rst → docs/source/tests/parameter.rst b/example/source/parameter.rst → docs/source/tests/parameter.rst
diff --git a/example/source/port.rst → docs/source/tests/port.rst b/example/source/port.rst → docs/source/tests/port.rst
diff --git a/example/requirements.txt → docs/source/tests/requirements.txt b/example/requirements.txt → docs/source/tests/requirements.txt
diff --git a/example/source/symbolator.rst → docs/source/tests/symbolator.rst b/example/source/symbolator.rst → docs/source/tests/symbolator.rst
diff --git a/example/source/verilog/carry4-whole.v → docs/source/tests/verilog/carry4-whole.v b/example/source/verilog/carry4-whole.v → docs/source/tests/verilog/carry4-whole.v
diff --git a/example/source/verilog_diagrams.rst → docs/source/tests/verilog_diagrams.rst b/example/source/verilog_diagrams.rst → docs/source/tests/verilog_diagrams.rst
diff --git a/environment.yml b/environment.yml
@@ -0,0 +1,19 @@
+name: sphinx-verilog-domain
+channels:
+- symbiflow
+- conda-forge
+- defaults
+dependencies:
+- python=3.7
+- docutils
+- sphinx
+- pango
+- pycairo
+- pygobject
+- yosys
+- netlistsvg
+- pip
+- pip:
+  - -r file:requirements.txt
+  - -r file:docs/requirements.txt
+  - .