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

Jump to bottom

clean up type references in docstrings #24

Open
dave-doty opened this issue Jun 8, 2021 · 1 comment
Open

clean up type references in docstrings #24

dave-doty opened this issue Jun 8, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@dave-doty
Copy link
Member

dave-doty commented Jun 8, 2021 •
edited
Loading

The most glaring example currently: https://ppsim.readthedocs.io/en/latest/#ppsim.simulation.Rule. That gets expanded wherever a parameter type is Rule, e.g., https://ppsim.readthedocs.io/en/latest/#ppsim.simulation.state_enumeration
@dave-doty dave-doty added the documentation Improvements or additions to documentation label Jun 8, 2021
@dave-doty
Copy link
Member Author

Here's a Sphinx option that may fix this: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_type_aliases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dave-doty