Skip to content

Commit 318719f

Browse files
PaebbelsPaebbels
committed
Updated shields in README and added introduction to the RTD documentation.
1 parent 098226a commit 318719f

File tree

3 files changed

+105
-31
lines changed

3 files changed

+105
-31
lines changed

‎README.md

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,66 @@
1-
![PyPI - License](https://img.shields.io/pypi/l/pyVHDLParser)
2-
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Paebbels/pyVHDLParser)
3-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/Paebbels/pyVHDLParser)
4-
[![Documentation Status](https://readthedocs.org/projects/pyvhdlparser/badge/?version=latest)](https://pyVHDLParser.readthedocs.io/en/latest/?badge=latest)
5-
[![PyPI](https://img.shields.io/pypi/v/pyVHDLParser)](https://pypi.org/project/pyVHDLParser/)
6-
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyVHDLParser)
7-
![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyVHDLParser)
8-
![PyPI - Status](https://img.shields.io/pypi/status/pyVHDLParser)
9-
10-
<!--
11-
[![Build Status](https://travis-ci.org/Paebbels/pyVHDLParser.svg?branch=master)](https://travis-ci.org/Paebbels/pyVHDLParser)
12-
-->
1+
[![PyPI - License](https://img.shields.io/pypi/l/pyVHDLParser?logo=PyPI)](LICENSE.md)
2+
[![GitHub tag (latest SemVer incl. pre-release)](https://img.shields.io/github/v/tag/Paebbels/pyVHDLParser?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyVHDLParser/tags)
3+
[![GitHub release (latest SemVer incl. including pre-releases)](https://img.shields.io/github/v/release/Paebbels/pyVHDLParser?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyVHDLParser/releases/latest)
4+
[![GitHub release date](https://img.shields.io/github/release-date/Paebbels/pyVHDLParser?logo=GitHub&)](https://github.com/Paebbels/pyVHDLParser/releases)
5+
[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyVHDLParser)](https://libraries.io/github/Paebbels/pyVHDLParser)
6+
[![Requires.io](https://img.shields.io/requires/github/Paebbels/pyVHDLParser)](https://requires.io/github/Paebbels/pyVHDLParser/requirements/?branch=master)
7+
[![Travis](https://img.shields.io/travis/com/Paebbels/pyVHDLParser?logo=Travis)](https://travis-ci.com/Paebbels/pyVHDLParser)
8+
[![PyPI](https://img.shields.io/pypi/v/pyVHDLParser?logo=PyPI)](https://pypi.org/project/pyVHDLParser/)
9+
![PyPI - Status](https://img.shields.io/pypi/status/pyVHDLParser?logo=PyPI)
10+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyVHDLParser?logo=PyPI)
11+
[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyVHDLParser)](https://github.com/Paebbels/pyVHDLParser/network/dependents)
12+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1155f244b6f54a3a95abdaa80d6771f8)](https://www.codacy.com/manual/Paebbels/pyVHDLParser)
13+
[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyVHDLParser)](https://libraries.io/github/Paebbels/pyVHDLParser/sourcerank)
14+
[![Read the Docs](https://img.shields.io/readthedocs/pyvhdlparser)](https://pyVHDLParser.readthedocs.io/en/latest/)
1315

1416
# pyVHDLParser
1517

1618
This is a token-stream based parser for VHDL-2008.
1719

18-
Main goals:
19-
* slice an input document into text blocks which are categorized
20-
* group text blocks for fast-forward scanning
21-
* provide a generic VHDL language model
20+
## Intruduction
2221

23-
Use cases:
24-
* generate documentation by using the fast-forward scanner
25-
* generate a document/language model by using the grouped text-block scanner
26-
* extract compile orders and other dependency graphs
27-
* generate highlighted syntax
28-
* re-annotate documenting comments to their objects for doc extraction
22+
### Main Goals
2923

30-
Long time goals:
31-
* A Sphinx language plugin for VHDL
24+
* **Parsing**
25+
* slice an input document into **tokens** and text **blocks** which are categorized
26+
* preserve case, whitespace and comments
27+
* recover on parsing errors
28+
* good error reporting / throw exceptions
29+
* **Fast Processing**
30+
* multi-pass parsing and analysis
31+
* delay analysis if not needed at current pass
32+
* link tokens and blocks for fast-forward scanning
33+
* **Generic VHDL Language Model**
34+
* Assemble a document-object-model (Code-DOM)
35+
* Provide an API for code introspection
36+
37+
### Use Cases
38+
39+
* generate documentation by using the fast-forward scanner
40+
* generate a document/language model by using the grouped text-block scanner
41+
* extract compile orders and other dependency graphs
42+
* generate highlighted syntax
43+
* re-annotate documenting comments to their objects for doc extraction
44+
45+
### Parsing approach
46+
47+
1. slice an input document into **tokens**
48+
2. assemble tokens to text **blocks** which are categorized
49+
3. assemble text blocks for fast-forward scanning into **groups**
50+
4. translate groups into a document-object-model (DOM)
51+
5. provide a generic VHDL language model
52+
53+
### Long time goals
54+
55+
* A Sphinx language plugin for VHDL
56+
57+
TODO: Move the following documentation to ReadTheDocs and replace it with a more lightweight version.
3258

3359
## Basic Concept
3460

3561
[![][concept]][concept]
3662

37-
[concept]: https://raw.githubusercontent.com/Paebbels/pyVHDLParser/master/docs/images/Linking_TokenBlockGroup.png
63+
[concept]: https://raw.githubusercontent.com/Paebbels/pyVHDLParser/master/doc/images/Linking_TokenBlockGroup.png
3864

3965
## Example 1
4066

‎doc/index.rst

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,59 @@
4949
The pyVHDLParser Documentation
5050
##############################
5151

52-
pyVHDLParser is a streaming parser for VHDL to extract the documentation.
52+
This is a token-stream based parser for VHDL-2008.
53+
54+
Main Goals
55+
**********
56+
57+
* **Parsing**
58+
59+
* slice an input document into **tokens** and text **blocks** which are categorized
60+
* preserve case, whitespace and comments
61+
* recover on parsing errors
62+
* good error reporting / throw exceptions
63+
64+
* **Fast Processing**
65+
66+
* multi-pass parsing and analysis
67+
* delay analysis if not needed at current pass
68+
* link tokens and blocks for fast-forward scanning
69+
70+
* **Generic VHDL Language Model**
71+
72+
* Assemble a document-object-model (Code-DOM)
73+
* Provide an API for code introspection
74+
75+
76+
Use Cases
77+
*********
78+
79+
* generate documentation by using the fast-forward scanner
80+
* generate a document/language model by using the grouped text-block scanner
81+
* extract compile orders and other dependency graphs
82+
* generate highlighted syntax
83+
* re-annotate documenting comments to their objects for doc extraction
84+
85+
86+
Parsing approach
87+
****************
88+
89+
1. slice an input document into **tokens**
90+
2. assemble tokens to text **blocks** which are categorized
91+
3. assemble text blocks for fast-forward scanning into **groups**
92+
4. translate groups into a document-object-model (DOM)
93+
5. provide a generic VHDL language model
94+
95+
96+
Long time goals
97+
***************
98+
99+
* A Sphinx language plugin for VHDL
100+
53101

54-
.. only:: html
55102

56-
News
57-
****
103+
News
104+
****
58105

59106
.. only:: html
60107

‎setup.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
setuptools.setup(
5252
name=projectName,
53-
version="0.4.1",
53+
version="0.4.2",
5454

5555
author="Patrick Lehmann",
5656
author_email="Paebbels@gmail.com",
@@ -79,7 +79,8 @@
7979
"Programming Language :: Python :: 3.6",
8080
"Programming Language :: Python :: 3.7",
8181
"Programming Language :: Python :: 3.8",
82-
"Development Status :: 3 - Alpha",
82+
"Development Status :: 2 - Pre-Alpha",
83+
# "Development Status :: 3 - Alpha",
8384
# "Development Status :: 5 - Production/Stable",
8485
"Intended Audience :: Developers",
8586
"Topic :: Utilities"

0 commit comments

Comments
 (0)