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

[Meta] Review sphinx and autodoc setup for documentation #324

Open
2 tasks
j-emberton opened this issue Oct 11, 2024 · 0 comments
Open
2 tasks

[Meta] Review sphinx and autodoc setup for documentation #324

j-emberton opened this issue Oct 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation meta Issues that act as the central point of reference for a larger piece of work

Comments

@j-emberton
Copy link
Collaborator

j-emberton commented Oct 11, 2024 •
edited
Loading

This meta issue captures the need to review our sphinx configuration to improve text display in ReadTheDocs.

Current setup:

  • Sphinx
  • Autodoc
  • Napoleon
  • Integrations into key dependencies i.e. Numpy

Issues:
@j-emberton j-emberton added meta Issues that act as the central point of reference for a larger piece of work documentation Improvements or additions to documentation labels Oct 11, 2024
@MarionBWeinzierl MarionBWeinzierl moved this from Todo to Icebox in ICCS development board Nov 28, 2024
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 meta Issues that act as the central point of reference for a larger piece of work
Projects
ICCS development board
Status: Icebox
Milestone
No milestone
Development

No branches or pull requests
1 participant
@j-emberton