Skip to content

Commit

Permalink
Merge pull request #96 from mithro/compat-module-description-update
Browse files Browse the repository at this point in the history
Update the description for the compatibility module.
  • Loading branch information
mithro authored Sep 22, 2023
2 parents 2ef1795 + 6cb5cb7 commit 7bd349a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
9 changes: 9 additions & 0 deletions compat/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
``sphinxcontrib-hdl-diagrams`` replaces ``sphinxcontrib-verilog-diagrams``
==========================================================================

sphinxcontrib-verilog-diagrams was renamed to
`sphinxcontrib-hdl-diagrams <https://github.com/SymbiFlow/sphinxcontrib-hdl-diagrams>`_
as it now supports more langauges than just verilog!

This stub module remains for backwards compatibility, but you should update to
using the new name.
19 changes: 5 additions & 14 deletions compat/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
from setuptools import setup, find_packages

__dir__ = path.dirname(path.abspath(__file__))
readme_file = path.join(__dir__, '../README.rst')
readme_file = path.join(__dir__, 'README.rst')
try:
with open(readme_file) as f:
readme = f.read()
Expand All @@ -39,25 +39,16 @@

setup(
name='sphinxcontrib-verilog-diagrams',
version="0.1.0",
description='Generate diagrams from Verilog in Sphinx.',
version="0.1.1",
description='Compatibility stub for renamed to sphinxcontrib-hdl-diagrams.',
long_description=readme,
long_description_content_type="text/x-rst",
author="The SymbiFlow Authors",
author_email='[email protected]',
url='https://github.com/SymbiFlow/sphinxcontrib-hdl-diagrams',
packages=find_packages(),
license="Apache 2.0",
keywords='Verilog sphinx sphinx-extension netlistsvg FPGA',
classifiers=[
'Development Status :: 4 - Beta',
'Framework :: Sphinx :: Extension',
'Intended Audience :: Developers',
'License :: OSI Approved :: Apache Software License',
'Natural Language :: English',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Topic :: Text Processing',
],
keywords='',
classifiers=[],
install_requires=install_requires,
)

0 comments on commit 7bd349a

Please sign in to comment.