Repository navigation
Standardize section headings around Python documentation standards - #279
Conversation
…s. Required a slight tweak to automodapi too. This mostly works except for one bug where a table coming from the ndarray documentation (which shows up in the API docs for the table.Column clas) is malformed. Not sure why that is happening now.
|
This looks good - just a note that you may need to update one heading after/if #278 is merged. |
|
Sure--this can wait 'til #278 is merged and then update it accordingly. |
|
I'm fine with this change, except for one concern: automodapi currently uses '^' and '_' for it's sub-sections and sub-sub-sections by default. Should this be changed to '-' and '^' now, then? |
|
@eteq Yeah, if you look at the diff I updated automodapi exactly as you suggested :) (Without doing so I got some nasty warnings about inconsistent headings) |
|
@iguananaut - Ah, I see - so you did... but you didn't update the docstring for |
|
@iguananaut - feel free to merge before #278, and I'll update #278 accordingly |
|
Okay |
…ect the new reality.
Standardize section headings around Python documentation standards
|
Oops--is there some way to reopen a pull request? I didn't even realize there were tests for automodapi. |
|
@iguananaut - FYI, I don't think it's possible to re-open, as that would require "un-merging". But your solution here if just referencing them from another commit worked fine. |
Standardize section headings around Python documentation standards
Standardize section headings around Python documentation standards
Need to run bootstrap.py when installing the developer version of setuptools
Add uncertainties roles
The Python documentation recommends the following convention for section headings for all its documentation:
http://docs.python.org/devguide/documenting.html#sections
(Ironically, the Python developers' guide itself does not appear to follow its own convention).
I think it would be nice though to follow this convention for Astropy's docs too though. This pull request fixes up all our docs to do so, I think (though I could have missed some spots). I did not update the io.fits docs in this PR because I'm working on reorganizing them in another branch (where they will follow this convention).
I'm also having one problem building the docs: When generating the documentation for the astropy.table.Column class there's a table that gets left out because it's malformatted somehow--the table actually comes from the docstrings for ndarray, which Column inherits from.