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

Better generated API documentation #8

Open
ebuchlin opened this issue Jun 27, 2023 · 3 comments
Open

Better generated API documentation #8

ebuchlin opened this issue Jun 27, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@ebuchlin
Copy link
Collaborator

Sphinx is configured, but the generated API documentation is missing links between modules and submodules.

As a result, the pages for the submodules are not directly accessible from the main documentation page (although they exist).
@ebuchlin
Copy link
Collaborator Author

ebuchlin commented Aug 20, 2023 •
edited
Loading

Tried to use this module documentation template in 2d8e655, doesn´t help much.

@ebuchlin
Copy link
Collaborator Author

See current online output on Read the Docs, issue is still present: class members not properly described. Also missing cross-references from package user manual (calibration.rst, catalog.rst...)

@ebuchlin ebuchlin added the documentation Improvements or additions to documentation label Oct 16, 2023
@ebuchlin
Copy link
Collaborator Author

Maybe merging with the output of the SunPy cookiecutter template could help.

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
@ebuchlin