Skip to content

Commit 2698a5f

Browse files
PaebbelsPaebbels
authored
Merge pull request #1 from VHDL/docs
Add documentation.
2 parents f7f9d4f + 5e98bd2 commit 2698a5f

35 files changed

+2649
-8
lines changed

‎.btd.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
input: doc
2+
output: _build
3+
requirements: requirements.txt
4+
target: gh-pages
5+
formats: [ html, pdf, man ]
6+
images:
7+
latex: btdi/latex
8+
theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v0

‎.github/workflows/doc.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Doc
2+
3+
on:
4+
push:
5+
6+
jobs:
7+
8+
btd:
9+
runs-on: ubuntu-latest
10+
steps:
11+
12+
- uses: actions/checkout@v2
13+
14+
- uses: buildthedocs/btd@v0
15+
with:
16+
token: ${{ github.token }}
17+
18+
- uses: actions/upload-artifact@master
19+
with:
20+
name: doc
21+
path: doc/_build/html

‎README.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyVHDLModel)](https://github.com/vhdl/pyVHDLModel/network/dependents)
1111
[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyVHDLModel)](https://libraries.io/github/vhdl/pyVHDLModel)
1212
[![Requires.io](https://img.shields.io/requires/github/vhdl/pyVHDLModel)](https://requires.io/github/vhdl/pyVHDLModel/requirements/?branch=master)
13-
[![Codacy - Quality](https://img.shields.io/codacy/grade/1155f244b6f54a3a95abdaa80d6771f8?logo=Codacy)](https://www.codacy.com/manual/vhdl/pyVHDLModel)
14-
[![Codacy - Coverage](https://img.shields.io/codacy/coverage/1155f244b6f54a3a95abdaa80d6771f8?logo=Codacy)](https://www.codacy.com/manual/vhdl/pyVHDLModel)
13+
[![Codacy - Quality](https://img.shields.io/codacy/grade/2286426d2b11417e90010427b7fed8e7?logo=Codacy)](https://www.codacy.com/manual/vhdl/pyVHDLModel)
14+
[![Codacy - Coverage](https://img.shields.io/codacy/coverage/2286426d2b11417e90010427b7fed8e7?logo=Codacy)](https://www.codacy.com/manual/vhdl/pyVHDLModel)
1515
[![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/vhdl/pyVHDLModel?logo=Codecov)](https://codecov.io/gh/vhdl/pyVHDLModel)
1616
[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyVHDLModel)](https://libraries.io/github/vhdl/pyVHDLModel/sourcerank)
1717
[![Read the Docs](https://img.shields.io/readthedocs/pyvhdlmodel)](https://pyVHDLModel.readthedocs.io/en/latest/)
@@ -20,14 +20,19 @@
2020

2121
An abstract VHDL language model written in Python.
2222

23-
## Introduction
24-
*tbd*
23+
## Main Goals
24+
This package provides a unified abstract language model for VHDL. Projects reading
25+
from source files can derive own classes and implement additional logic to create
26+
a concrete language model for their tools.
2527

26-
### Main Goals
27-
*tbd*
28+
Projects consuming pre-processed VHDL data (parsed, analyzed or elaborated) can
29+
build higher level features and services on such a model, while supporting multiple
30+
frontends.
2831

29-
### Use Cases
30-
*tbd*
32+
33+
## Use Cases
34+
* High-level API for GHDL's `libghdl` offered via `pyghdl`.
35+
* Code Document-Object-Model (Code-DOM) in `pyVHDLParser`.
3136

3237

3338

‎doc/ChangeLog/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
ChangeLog
2+
#########
3+
4+
Upcoming Release
5+
================
6+
7+
* tbd
8+
9+
26.12.2020
10+
==========
11+
12+
`pyVHDLModel` was split from `pyVHDLParser` (v0.6.0) as an independent Python package.

‎doc/Glossary.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Glossary
2+
########
3+
4+
.. glossary::
5+
6+
LRM
7+
IEEE Standard for VHDL Language Reference Manual
8+
9+
* IEEE Std. 1076-1987
10+
* IEEE Std. 1076-1993
11+
* IEEE Std. 1076-2002
12+
* IEEE Std. 1076-2008 - https://standards.ieee.org/standard/1076-2008.html
13+
* IEEE Std. 1076-2019 - https://standards.ieee.org/standard/1076-2019.html

‎doc/Installation.rst

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
.. _installation:
2+
3+
Installation/Updates
4+
####################
5+
6+
7+
8+
.. _installation-pip:
9+
10+
Using PIP
11+
*********
12+
13+
Installation using PIP
14+
======================
15+
16+
.. code-block:: bash
17+
18+
pip3 install pyVHDLModel
19+
20+
21+
Updating using PIP
22+
==================
23+
24+
.. code-block:: bash
25+
26+
pip3 install -U pyVHDLModel
27+
28+
29+
30+
.. _installation-setup:
31+
32+
Using setup.py
33+
**************
34+
35+
.. todo::
36+
37+
Describe setup procedure using ``setup.py``
38+
39+
40+
41+
.. _dependency:
42+
43+
Dependencies
44+
************
45+
46+
.. _dependency-package:
47+
48+
pyVHDLModel Package
49+
===================
50+
51+
* py-flags
52+
* pydecor
53+
54+
55+
.. _dependency-testing:
56+
57+
Unit Testing / Coverage
58+
=======================
59+
60+
* Coverage
61+
62+
63+
.. _dependency-documentation:
64+
65+
Sphinx Documentation
66+
====================
67+
68+
* Sphinx
69+
* sphinx-rtd-theme
70+
* sphinx.ext.coverage
71+
* autoapi
72+
* sphinx_fontawesome
73+
* sphinx_autodoc_typehints
74+
* btd.sphinx.graphviz
75+
* btd.sphinx.inheritance_diagram
76+
* Pygments

‎doc/LanguageModel/ConcurrentStatements.rst

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. _lngmod-constm:
2+
3+
Concurrent Statements
4+
#####################
5+
6+
* Assert
7+
* Signal assignment
8+
* Instantiation
9+
* If generate
10+
* Case generate
11+
* For generate
12+
* Procedure call
13+
* Process
14+
15+
Assert
16+
======
17+
18+
.. todo::
19+
20+
Write documentation.
21+
22+
Signal Assignment
23+
=================
24+
25+
.. todo::
26+
27+
Write documentation.
28+
29+
Instantiation
30+
=============
31+
32+
.. todo::
33+
34+
Write documentation.
35+
36+
If Generate
37+
===========
38+
39+
.. todo::
40+
41+
Write documentation.
42+
43+
Case Generate
44+
=============
45+
46+
.. todo::
47+
48+
Write documentation.
49+
50+
For Generate
51+
============
52+
53+
.. todo::
54+
55+
Write documentation.
56+
57+
Procedure Call
58+
==============
59+
60+
.. todo::
61+
62+
Write documentation.
63+
64+
Process
65+
=======
66+
67+
.. todo::
68+
69+
Write documentation.
70+

0 commit comments

Comments
 (0)