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.

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

merged 3 commits into from
Nov 10, 2024

Conversation

oscargus
Copy link
Contributor

@oscargus oscargus commented Nov 4, 2024

Documentation

  • Started reading up on pyVHDLModel and found some minor issues in the documentation.

#. 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.

* 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

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 :).

#. 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
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.

@Paebbels
Copy link
Member

Paebbels commented Nov 4, 2024

If you have questions, you can also contact me via Gitter or by email. Writing documentation for this monster is not an easy and quick task :). I hope the naming of classes helps understanding it.

@Paebbels Paebbels mentioned this pull request Nov 10, 2024
@Paebbels Paebbels changed the base branch from main to dev November 10, 2024 14:28
@Paebbels Paebbels merged commit bc5496a into VHDL:dev Nov 10, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants