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

DOC: Update ReadtheDocs structure or theme #101

Open
3 tasks
nawtrey opened this issue Aug 9, 2024 · 0 comments
Open
3 tasks

DOC: Update ReadtheDocs structure or theme #101

nawtrey opened this issue Aug 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@nawtrey
Copy link
Collaborator

nawtrey commented Aug 9, 2024

There are a few changes I wasn't able to implement in GH-100 that I would like to list here:

  • For the API pages, change to use the page titles/headers instead of the module names (i.e. "Probability and Flux Calculations" instead of "kda.calculations". While the titles are annoying, it is also an issue because the 4th depth level is the KDA functions, which have tiny font and are basically unreadable. If we removed the 2nd depth level "kda.calculations", etc. it would look a lot better I think.
  • Remove the redundant "Functions" and "Classes" at the bottom of each API page. I don't know why we would want a table of the functions listed at the bottom
  • Add a "Home" link to the sidebar that links back to index.rst. I believe there is a simple way to do this where you make some other file (i.e. master.rst) the master file in the conf.py and then you add index.rst to the main toctree as Home <index> or something like that.
@nawtrey nawtrey added the documentation Improvements or additions to documentation label Aug 9, 2024
@nawtrey nawtrey changed the title DOC: Update RTD structure or theme DOC: Update ReadTheDocs structure or theme Aug 10, 2024
@nawtrey nawtrey changed the title DOC: Update ReadTheDocs structure or theme DOC: Update ReadtheDocs structure or theme Aug 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant