diff --git a/.btd.yml b/.btd.yml index 48c0b3ec5..7f53d8103 100644 --- a/.btd.yml +++ b/.btd.yml @@ -6,4 +6,4 @@ formats: [ html, pdf, man ] images: base: vhdl/doc latex: btdi/latex -theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v0 +theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v1 diff --git a/README.md b/README.md index 4a3c3a2ee..c9e60de17 100644 --- a/README.md +++ b/README.md @@ -19,32 +19,39 @@ [![Documentation License](https://img.shields.io/badge/doc%20license-CC--BY%204.0-green)](LICENSE.md) [![Documentation - Read Now!](https://img.shields.io/badge/doc-read%20now%20%E2%9E%94-blueviolet)](https://vhdl.github.io/pyVHDLModel/) -# pyVHDLModel - An abstract VHDL language model written in Python. +

+ +

+ + ## Main Goals -This package provides a unified abstract language model for VHDL. Projects reading -from source files can derive own classes and implement additional logic to create -a concrete language model for their tools. -Projects consuming pre-processed VHDL data (parsed, analyzed or elaborated) can -build higher level features and services on such a model, while supporting multiple -frontends. +This package provides a unified abstract language model for VHDL. +Projects reading from source files can derive own classes and implement additional logic to create a concrete language +model for their tools. + +Projects consuming pre-processed VHDL data (parsed, analyzed or elaborated) can build higher level features and services +on such a model, while supporting multiple frontends. ## Use Cases -**pyVHDLModel Generators** + +### pyVHDLModel Generators + * High-level API for [GHDL's](https://github.com/ghdl/ghdl) `libghdl` offered via `pyghdl`. * Code Document-Object-Model (Code-DOM) in [pyVHDLParser](https://github.com/Paebbels/pyVHDLParser). -**pyVHDLModel Consumers** +### pyVHDLModel Consumers + * Create graphical views of VHDL files or designs. Possible candidates: [Symbolator](https://github.com/kevinpt/symbolator) * Created a (re)formatted output of VHDL. ## Examples + ### List all Entities with Generics and Ports The following tiny example is based on GHDL's [`pyGHDL.dom`](https://github.com/ghdl/ghdl/tree/master/pyGHDL/dom) package implementing @@ -76,10 +83,8 @@ for entity in document.Entities: ``` - - - ## Contributors + * [Patrick Lehmann](https://github.com/Paebbels) (Maintainer) * [Unai Martinez-Corral](https://github.com/umarcor) * [and more...](https://github.com/VHDL/pyVHDLModel/graphs/contributors) diff --git a/doc/Dependency.rst b/doc/Dependency.rst index c781faf0d..7cb1a0af7 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -6,11 +6,11 @@ Dependency .. |img-pyVHDLModel-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyVHDLModel :alt: Libraries.io status for latest release :height: 22 - :target: https://libraries.io/github/Paebbels/pyVHDLModel -.. |img-pyVHDLModel-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyVHDLModel + :target: https://libraries.io/github/VHDL/pyVHDLModel +.. |img-pyVHDLModel-req-status| image:: https://img.shields.io/requires/github/VHDL/pyVHDLModel :alt: Requires.io :height: 22 - :target: https://requires.io/github/Paebbels/pyVHDLModel/requirements/?branch=master + :target: https://requires.io/github/VHDL/pyVHDLModel/requirements/?branch=master +------------------------------------------+------------------------------------------+ | `Libraries.io `_ | `Requires.io `_ | diff --git a/doc/_static/.gitempty b/doc/_static/.gitempty deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/_static/banner.svg b/doc/_static/banner.svg new file mode 100644 index 000000000..045988a50 --- /dev/null +++ b/doc/_static/banner.svg @@ -0,0 +1,209 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/_static/favicon.svg b/doc/_static/favicon.svg new file mode 100644 index 000000000..350dfb7fa --- /dev/null +++ b/doc/_static/favicon.svg @@ -0,0 +1,90 @@ + + + + + + + + + + image/svg+xml + + + + + + + pyVHDL + + diff --git a/doc/_static/logo.svg b/doc/_static/logo.svg new file mode 100644 index 000000000..587d43488 --- /dev/null +++ b/doc/_static/logo.svg @@ -0,0 +1,216 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/conf.py b/doc/conf.py index 387ba9039..cf691865e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -37,7 +37,7 @@ def _LatestTagName(): # The full version, including alpha/beta/rc tags version = "0.13" # The short X.Y version. -release = "0.13.0" # The full version, including alpha/beta/rc tags. +release = "0.13.1" # The full version, including alpha/beta/rc tags. try: if _IsUnderGitControl: latestTagName = _LatestTagName()[1:] # remove prefix "v" @@ -89,8 +89,9 @@ def _LatestTagName(): # Options for HTML output # ============================================================================== html_theme_options = { - 'home_breadcrumbs': True, - 'vcs_pageview_mode': 'blob', + 'logo_only': True, + 'home_breadcrumbs': True, + 'vcs_pageview_mode': 'blob', } html_context = {} @@ -106,6 +107,9 @@ def _LatestTagName(): # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_logo = str(Path(html_static_path[0]) / "logo.svg") +html_favicon = str(Path(html_static_path[0]) / "favicon.svg") + # Output file base name for HTML help builder. htmlhelp_basename = 'pyVHDLModelDoc' diff --git a/pyVHDLModel/__init__.py b/pyVHDLModel/__init__.py index d62310e54..1a52087fd 100644 --- a/pyVHDLModel/__init__.py +++ b/pyVHDLModel/__init__.py @@ -46,7 +46,7 @@ from pydecor import export -__version__ = "0.13.0" +__version__ = "0.13.1" SimpleOrAttribute = Union['SimpleName', 'AttributeName'] diff --git a/requirements.txt b/requirements.txt index a479bcae7..b0f362aea 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1 @@ -# py-flags>=1.1.4 pydecor>=2.0.1 diff --git a/setup.py b/setup.py index dd6ae4414..1a8928301 100644 --- a/setup.py +++ b/setup.py @@ -53,7 +53,7 @@ # Assemble all package information setuptools_setup( name=projectName, - version="0.13.0", + version="0.13.1", author="Patrick Lehmann", author_email="Paebbels@gmail.com",