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

docstrings links to other autodocs #90

Open
hareball90 opened this issue Aug 28, 2023 · 1 comment
Open

docstrings links to other autodocs #90

hareball90 opened this issue Aug 28, 2023 · 1 comment
Labels

Comments

@hareball90
Copy link
Collaborator

links within auto-generated documentation are not linking to the other internal code documentation...suspect they are written in an incompatible format (either rst or md)

within the notebooks/markdown files, referencing classes, functions etc are done by {func}funcname or {class}classname

see jupyterbook documentation or other pygom notebooks for examples

@hareball90
Copy link
Collaborator Author

hareball90 commented Aug 29, 2023

this might need explicit referencing, in the form (doclink)[funcname]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant