Description of the problem/new feature
With the switch to using the pydata-sphinx-theme theme, the table of contents in the docs is pretty useless since most of the pages are single sections. It would make sense to reorganize things a bit into categories. Good examples are the docs for NumPy, SciPy, Astropy, and HyperSpy.
The new layout would look something like:
- Getting Started
- intro to baseline correction & pybaselines
- installation (or maybe install first, then intro?)
- quick start
- User Guide
- algorithms
- parameter selection
- performance
- masking
- Examples
- API Reference
- Contributing
- About/Project Details
I'll need to add a lot of redirects on rtd so that existing links to the docs don't break... Also need to update the PR template for the re-sectioned links in the docs
Description of the problem/new feature
With the switch to using the
pydata-sphinx-themetheme, the table of contents in the docs is pretty useless since most of the pages are single sections. It would make sense to reorganize things a bit into categories. Good examples are the docs for NumPy, SciPy, Astropy, and HyperSpy.The new layout would look something like:
I'll need to add a lot of redirects on rtd so that existing links to the docs don't break... Also need to update the PR template for the re-sectioned links in the docs