Package sphinx-verilog-domain

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>

Author: rw1nkler

.gitignore

@@ -1,4 +1,25 @@
-__pycache__/
 build/
+
+# 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

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 = [ 'sphinxcontrib-verilog-domain' ]
 
 Usage
 -----

setup.py

@@ -0,0 +1,32 @@
+import setuptools
+
+with open("README.rst", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="sphinx-verilog-domain",
+    version="0.0.1",
+    author="SymbiFlow Authors",
+    author_email="symbiflow@lists.librecores.org",
+    description="Verilog Domain for Sphinx",
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
+    url="https://github.com/SymbiFlow/sphinx-verilog-domain",
+    python_requires=">=3.7",
+    packages=setuptools.find_packages(),
+    install_requires=[
+       'setuptools',
+       'docutils',
+       'sphinx',
+       'lark-parser'
+    ],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Framework :: Sphinx :: Extension',
+        'Intended Audience :: Developers',
+        "License :: OSI Approved :: ISC License (ISCL)",
+        "Programming Language :: Python :: 3",
+        'Natural Language :: English',
+        'Topic :: Documentation :: Sphinx',
+    ],
+)

sphinx-verilog-domain/__init__.py

@@ -0,0 +1,12 @@
+from sphinx.application import Sphinx
+from .verilogdomain import VerilogDomain
+
+def setup(app: Sphinx):
+    app.add_config_value('verilog_domain_debug', [], '')
+    app.add_domain(VerilogDomain)
+
+    return {
+        "version": "0.0.2",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

sphinxcontrib/verilog.lark renamed to sphinx-verilog-domain/verilog.lark

@@ -753,13 +753,3 @@ def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
         qualified_name_without_root = VerilogQualifiedIdentifier(obj.qualified_name[1:])
         tooltip = f"{obj.objtype} {qualified_name_without_root}" if obj.objtype else f"{qualified_name_without_root}"
         return make_refnode(builder, fromdocname, obj.docname, obj.linktarget, contnode, tooltip)
-
-def setup(app):
-    app.add_config_value('verilog_domain_debug', [], '')
-    app.add_domain(VerilogDomain)
-
-    return {
-        "version": "0.1",
-        "parallel_read_safe": True,
-        "parallel_write_safe": True,
-    }