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

use sphinx autosummary to make one doc page per function #149

Closed
wants to merge 9 commits into from

Conversation

wholmgren
Copy link
Member

@wholmgren wholmgren commented Apr 15, 2016

I'd like to change to API documentation format to have:

  1. a separate summary page for each module
  2. a separate detailed page for each function

see the new documentation here:

http://wholmgren-pvlib-python-new.readthedocs.org/en/doc-reorg2/modules.html

I think it's a lot easier to navigate this. Separate pages for each function also makes it reasonable to add example documentation for each function (like the matlab library already has) and was discussed in #62.

@wholmgren wholmgren added this to the 0.3.1 milestone Apr 15, 2016
@alorenzo175
Copy link
Contributor

Looks good except for the scrollbars on the tables. You might try some custom CSS so that the descriptions wrap like in qtile/qtile@3eadbbf.

@alorenzo175
Copy link
Contributor

Also, is there a way to have the +- boxes in the menu on the left for the autosummary items (like in Time and time zones)?

@wholmgren
Copy link
Member Author

I applied that scroll bar patch. Nice find. The some of the tables look a little messy, but I prefer this to scrolling.

I noticed earlier that the +/- symbols were not being created, but I couldn't figure out how to fix it.

autosummary is creating new pages for imported functions and classes. Not sure if this due to a sphinx bug or if I'm doing something wrong.

@wholmgren wholmgren modified the milestones: 0.3.2, 0.3.1 Apr 20, 2016
@wholmgren wholmgren modified the milestones: 0.3.3, 0.3.2 May 4, 2016
@wholmgren
Copy link
Member Author

I forgot to add that I am fairly sure that the duplicated pages are due to a sphinx bug, and I'm waiting to merge this until they fix it.

@wholmgren wholmgren modified the milestones: 0.4.0, 0.3.3 Jun 14, 2016
@wholmgren wholmgren modified the milestones: Someday, 0.4.0 Jul 27, 2016
@wholmgren
Copy link
Member Author

closed in favor of #258.

@wholmgren wholmgren closed this Nov 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants