Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation fixes #86

Merged
merged 3 commits into from
Nov 10, 2024
Merged

Minor documentation fixes #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ac0644
v0.29.0
Paebbels Sep 26, 2024
99b87a9
v0.29.1
Paebbels Nov 3, 2024
17e00ad
Minor documentation fixes
oscargus Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/DataStructure/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cross-references or dedicated data structure (tree, graph, …) for connecting m
Graphs
******

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

Dependency Graph
Expand All @@ -29,7 +29,7 @@ The dependency graph describes dependencies between:

The relation can be:

* Defined in source file
* defined in source file
* references
* implements
* instantiates
Expand All @@ -55,11 +55,11 @@ Compile Order Graph
The compile order can be derived from dependency graph by:

1. copying all document vertices
2. iterating all edges in the dependency graph.
1. resolve the source and the destination to the referenced design units
2. resolved further to the documents these design units are declared in
3. resolve further which vertices correspond in the compile order graph
4. if edges does not yet exist, add an edge between two documents in the compile order graph
2. iterating all edges in the dependency graph
#. resolve the source and the destination to the referenced design units
#. resolved further to the documents these design units are declared in
#. resolve further which vertices correspond in the compile order graph
#. if edges does not yet exist, add an edge between two documents in the compile order graph
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inner list didn't render as a list. This may fix that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In ReStructured Text, an empty line is needed between inner and outer lists. I'm not sure if # works. I know Markdown has such a syntax extension.



.. toctree::
Expand Down
6 changes: 3 additions & 3 deletions doc/GettingStarted.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pyVHDLParser
************

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

.. warning:: Currently, pyVHDLParser is not aligned with latest updates in pyVHDLModel.
Expand Down Expand Up @@ -227,8 +227,8 @@ On Mac
Using libghdl with Python
=========================

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

.. admonition:: GettingStarted.py

Expand Down
4 changes: 2 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ frontends.
Use Cases
*********

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

@oscargus oscargus Nov 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the idea is to point to the repo or the docs, but the pyGHDL-link was dead and I guessed that the docs may be better for pyVHDLParser...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, docs is better :).



.. _news:
Expand Down