Setup environment using make-env

Signed-off-by: Robert Winkler <[email protected]>

Author: rw1nkler

.gitignore

@@ -1,4 +1,5 @@
 build/
+env/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

Makefile

@@ -0,0 +1,20 @@
+# 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

README.rst

@@ -15,7 +15,7 @@ Enabling
 
 Add extension in ``conf.py``::
 
-    extensions = [ 'sphinxcontrib-verilog-domain' ]
+    extensions = [ 'sphinx-verilog-domain' ]
 
 Usage
 -----
@@ -62,7 +62,6 @@ Nesting::
 
             Reference to module ``Top1``'s port ``a``: :verilog:ref:`Top1.a`.
 
-
 Namespaces
 ^^^^^^^^^^
 
@@ -87,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

docs/requirements.txt

@@ -2,3 +2,4 @@ git+https://github.com/SymbiFlow/sphinx_symbiflow_theme
 
 sphinx
 symbolator
+sphinxcontrib-verilog-diagrams

docs/source/conf.py

@@ -32,7 +32,8 @@
 # ones.
 extensions = [
   'sphinx-verilog-domain',
-  'symbolator_sphinx'
+  'symbolator_sphinx',
+  'sphinxcontrib_verilog_diagrams'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

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
+  - .

setup.py

@@ -14,11 +14,13 @@
     url="https://github.com/SymbiFlow/sphinx-verilog-domain",
     python_requires=">=3.7",
     packages=setuptools.find_packages(),
+    package_data={'': ["verilog.lark"]},
+    include_package_data=True,
     install_requires=[
-       'setuptools',
-       'docutils',
-       'sphinx',
-       'lark-parser'
+        'setuptools',
+        'docutils',
+        'sphinx',
+        'lark-parser'
     ],
     classifiers=[
         'Development Status :: 4 - Beta',