-
Notifications
You must be signed in to change notification settings - Fork 997
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
api.rst and autosummary replaces long modules and classes doc pages #258
Conversation
This is going to make it a lot easier to find the function I am looking Thanks! I think it makes a lot of sense to have the Classes overview. On Wed, Oct 26, 2016 at 3:14 PM, Will Holmgren notifications@github.com
|
I still don't know how all this works, but I had noticed the big long On 2016-10-27 0:14, Will Holmgren wrote:
Photovoltaic Performance Labs Germany +49-761-8973-5603 (Europe) |
Thanks for the feedback! |
I created a new api.rst to replace the modules.rst and classes.rst documentation pages. I dislike the fact that our existing documentation has all of the function, class, and method definitions on one huge page. #149 tried to use sphinx autosummary to make individual documentation pages, but I could never get it to work quite right (probably due to a sphinx bug). This manually created api.rst+autosummary actually does work, and it also groups functions and methods into categories instead of simply showing them in alphabetical order.
Rendered docs:
http://wholmgren-pvlib-python-new.readthedocs.io/en/manualdoc/api.html
I like this a lot better, but let me know if you disagree or if you find problems.
The only downside that I can think of is that new functions/methods/classes/modules have to be manually added to the documentation, but I think that's worth it.