Skip to content

Commit bc5496a

Browse files
authored
Minor documentation fixes
2 parents 5255f2f + 17e00ad commit bc5496a

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

doc/DataStructure/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cross-references or dedicated data structure (tree, graph, …) for connecting m
99
Graphs
1010
******
1111

12-
pyVHDLModel uses the graph implementation from :pyTool:mod:`pyTooling.Graph` as it provides an object oriented programming
12+
pyVHDLModel uses the graph implementation from :py:mod:`pyTooling.Graph` as it provides an object oriented programming
1313
interface to vertices and edges.
1414

1515
Dependency Graph
@@ -29,7 +29,7 @@ The dependency graph describes dependencies between:
2929

3030
The relation can be:
3131

32-
* Defined in source file
32+
* defined in source file
3333
* references
3434
* implements
3535
* instantiates
@@ -55,11 +55,11 @@ Compile Order Graph
5555
The compile order can be derived from dependency graph by:
5656

5757
1. copying all document vertices
58-
2. iterating all edges in the dependency graph.
59-
1. resolve the source and the destination to the referenced design units
60-
2. resolved further to the documents these design units are declared in
61-
3. resolve further which vertices correspond in the compile order graph
62-
4. if edges does not yet exist, add an edge between two documents in the compile order graph
58+
2. iterating all edges in the dependency graph
59+
#. resolve the source and the destination to the referenced design units
60+
#. resolved further to the documents these design units are declared in
61+
#. resolve further which vertices correspond in the compile order graph
62+
#. if edges does not yet exist, add an edge between two documents in the compile order graph
6363

6464

6565
.. toctree::

doc/GettingStarted.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ pyVHDLParser
1414
************
1515

1616
The pyVHDLParser is a token-stream based parser creating a code document object model (CodeDOM) derived from
17-
pyVHDLModel. Actually, pyVHDlModel was originally part of that parser, until it got refactored into this standalone
17+
pyVHDLModel. Actually, pyVHDLModel was originally part of that parser, until it got refactored into this standalone
1818
package so multiple frontends (parsers) and backends (analysis tools) can use this VHDL language model as a common API.
1919

2020
.. warning:: Currently, pyVHDLParser is not aligned with latest updates in pyVHDLModel.
@@ -227,8 +227,8 @@ On Mac
227227
Using libghdl with Python
228228
=========================
229229

230-
An environment variable :envvar:`GHDL_PREFIX=C:\\Tools\\GHDL\\3.0.0-dev\\lib\\ghdl` is needed for libghdl. The path is
231-
constructed from installation path plus ``lib\\ghdl``.
230+
An environment variable :envvar:`GHDL_PREFIX=C:\\Tools\\GHDL\\3.0.0-dev\\lib\\ghdl` is needed for ``libghdl``. The path is
231+
constructed from installation path plus ``lib\ghdl``.
232232

233233
.. admonition:: GettingStarted.py
234234

doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ frontends.
5454
Use Cases
5555
*********
5656

57-
* High-level API for `GHDL's <https://GitHub.com/ghdl/ghdl>`__ `libghdl` offered via `pyGHDL <https://ghdl.github.io/ghdl/using/pyGHDL/index.html>`__.
58-
* Code Document-Object-Model (Code-DOM) in `pyVHDLParser <https://GitHub.com/Paebbels/pyVHDLParser>`__.
57+
* High-level API for `GHDL's <https://GitHub.com/ghdl/ghdl>`__ `libghdl` offered via `pyGHDL <https://ghdl.github.io/ghdl/pyGHDL/pyGHDL.html>`__.
58+
* Code Document-Object-Model (Code-DOM) in `pyVHDLParser <https://paebbels.github.io/pyVHDLParser/>`__.
5959

6060

6161
.. _news:

0 commit comments

Comments
 (0)