Skip to content

Include full attribute docstrings in autosummary - #268

Merged
eteq merged 5 commits into
astropy:masterfrom
mdboom:docs/full-attribute-docstrings
Jun 13, 2012
Merged

eteq merged 5 commits into
astropy:masterfrom
mdboom:docs/full-attribute-docstrings

Conversation

@mdboom

@mdboom mdboom commented Jun 8, 2012

Copy link
Copy Markdown
Contributor

This is required for the WCS docs (pull #267), where there are many complex-to-describe properties.

This is similar to the change made for methods in #217.

mdboom added 2 commits June 8, 2012 12:40
…ds. This is required for the WCS docs, where there are many complex-to-describe properties.
@eteq

eteq commented Jun 8, 2012

Copy link
Copy Markdown
Member

This seems fine, except for two things:

  • Can you move the "Attribute Documentation" after the "Methods Summary" section? That way the summaries all come before the actual documentation.
  • I get 4 warnings that now appear when I build the docs. I'll see about fixing them and I'll submit a PR to your branch

…revent conflict with columns attribute of astropy.table.Table
@eteq

eteq commented Jun 8, 2012

Copy link
Copy Markdown
Member

See mdboom#4 for a fix for 3 of the 4 warnings that result. The last one is more complicated and I'm fine with merging this and fixing that separately.

…es Summary, Methods Summary, Attributes Documentation, Methods Documentation". Fix so empty "Methods Summary" and "Methods Documentation" sections are not created.
@mdboom

mdboom commented Jun 11, 2012

Copy link
Copy Markdown
Contributor Author

Changed the ordering of the elements.

I also fixed a minor problem whereby if a class had no methods empty "Methods Summary" and "Methods Documentation" sections were still being created.

@eteq

eteq commented Jun 11, 2012

Copy link
Copy Markdown
Member

@mdboom - are you going to merge mdboom#4 into this (that's on your branch here, so it would be included in this PR) or should we merge this and have me apply that separately?

(Other than that, I think this is good to merge)

@mdboom

mdboom commented Jun 11, 2012

Copy link
Copy Markdown
Contributor Author

I'm just waiting for @iguananaut to comment on it as it affects the io.fits documentation, but I suspect the likelihood of it being a problem is low.

@embray

embray commented Jun 11, 2012

Copy link
Copy Markdown
Member

Looks fine to me.
This reminds me that at some point I need to go through pyfits' docstrings and make links out of all the ticket references.

@eteq

eteq commented Jun 13, 2012

Copy link
Copy Markdown
Member

I'll go ahead and merge this, and try to solve the final remaining warning separately.

eteq added a commit that referenced this pull request Jun 13, 2012
Include full attribute docstrings in autosummary
@eteq
eteq merged commit faaea37 into astropy:master Jun 13, 2012
keflavich pushed a commit to keflavich/astropy that referenced this pull request Oct 9, 2013
…ings

Include full attribute docstrings in autosummary
@mdboom
mdboom deleted the docs/full-attribute-docstrings branch May 21, 2014 23:54
astrofrog pushed a commit to astrofrog/astropy that referenced this pull request Jun 12, 2019
Adding collections.abc classes to the local sphinx inventories
jeffjennings pushed a commit to jeffjennings/astropy that referenced this pull request Jul 2, 2025
Fix astropy#262: Add total number of affiliated packages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants