DOC: Update RTD pages - Githubissues

Becksteinlab / kda

Python package used for the analysis of biochemical kinetic diagrams.

GNU General Public License v3.0

3 stars 1 forks source link

DOC: Update RTD pages #100

Closed nawtrey closed 3 months ago

nawtrey commented 3 months ago

Changes

Removes "Functions" section from every API ref page
Add numbers to TOC
Moves intallation notes to its own page in installation.rst
Changes "API Documentation" to "API Reference"

nawtrey commented 3 months ago

What I really wanted to do was change the TOC sidebar titles for each module to display the module title instead of the module name (i.e. "Probability and Flux Calculations" instead of "kda.calculations"), but apparently that requires a custom HTML template or a restructuring of the docs pages. I tried the latter (which worked) but it was going to be too much work to write up a detailed page for each module, so I decided to scrap it and simply implement a few changes.

nawtrey commented 3 months ago

Everything is looking good. Merging.