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

Add documentation arguments to builder #1740

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

bayi
Copy link

@bayi bayi commented Aug 2, 2023

New arguments for documentation generation

This PR adds the following new arguments to builder:

  • doc-project= String: The project name that should be displayed in the documentation. Defaults to the soc name.
  • doc-author= String: The author of the documentation. Defaults to LiteX
  • doc-extra-config= String: the extra config options that should be included in the generated sphinx conf. ( Like setting a different theme )

The argument member property names have underscores instead of dashes in their names.

@enjoy-digital
Copy link
Owner

Thanks @bayi, this is interesting. Some work has been planned on documentation in September, I'll probably wait to start this to also closely review/merge the PR.

@bayi
Copy link
Author

bayi commented Aug 3, 2023

Well the reasoning behind my changes are:

I wanted to use a different theme for the sphinx docs, so installed the rtd theme and i had to actually copy the interconnect/builder.py to my project and just give it the html_theme = 'sphinx_rtd_theme' for the extra config.

Now i can do that with args from my soc definition.

Im using it like this:

kép

Which ends up with a nice documentation generated like this:

kép

Also while we are here, do you know how can i make the CSRField names fit the WaveDrom graph if they are longer ? :)

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.

None yet

2 participants