Skip to content

Move all subpackage docs to directories - #277

Merged
eteq merged 4 commits into
astropy:masterfrom
eteq:docs/move-pkg-docs-to-dirs
Jun 14, 2012
Merged

eteq merged 4 commits into
astropy:masterfrom
eteq:docs/move-pkg-docs-to-dirs

Conversation

@eteq

@eteq eteq commented Jun 14, 2012

Copy link
Copy Markdown
Member

This is based on a discussion from #271 - after considering the fact that we want to preserve hyperlinks on the web docs, all subpackage documentation should always be in its own directory. This requires moving all the docs, which would screw up #272 and #276. Hence, I will hold off on doing this until those two PRs are merged.

The _pkgtemplate.rst also needs to be updated to reflect this rule.

@ghost ghost assigned eteq Jun 13, 2012
@eteq

eteq commented Jun 13, 2012

Copy link
Copy Markdown
Member Author

#279 would also conflict.

@eteq

eteq commented Jun 14, 2012

Copy link
Copy Markdown
Member Author

#245 takes care of this for fits

@eteq

eteq commented Jun 14, 2012

Copy link
Copy Markdown
Member Author

The attached code implements this, as well as tweaking _pkgtemplate.rst to match the sectioning rules (from #279 - @iguananaut may want to double-check this) and describe where the files should go. It's only re-organizing, so I'll merge this tomorrow if there are no objections.

@embray

embray commented Jun 14, 2012

Copy link
Copy Markdown
Member

Looks sensible to me.

eteq added a commit that referenced this pull request Jun 14, 2012
Move all subpackage docs to directories
@eteq
eteq merged commit e632b26 into astropy:master Jun 14, 2012
keflavich pushed a commit to keflavich/astropy that referenced this pull request Oct 9, 2013
@eteq
eteq deleted the docs/move-pkg-docs-to-dirs branch May 3, 2015 17:16
astrofrog pushed a commit to astrofrog/astropy that referenced this pull request Jun 12, 2019
ntessore pushed a commit to glass-dev/cosmology that referenced this pull request Dec 7, 2020
…o-dirs

Move all subpackage docs to directories
jeffjennings pushed a commit to jeffjennings/astropy that referenced this pull request Jul 2, 2025
Add me to pacakge template maintainer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants