Skip to content

Move docs/fits to docs/io/fits - #245

Merged
embray merged 3 commits into
astropy:masterfrom
embray:issue-245
Jun 14, 2012
Merged

embray merged 3 commits into
astropy:masterfrom
embray:issue-245

Conversation

@embray

@embray embray commented Jun 14, 2012

Copy link
Copy Markdown
Member

Since some new doc infrastructure (See #217) is now assumes that the code structure is parallel to the docs structure, docs/fits should be moved to docs/io/fits.

@ghost ghost assigned embray May 23, 2012
@embray

embray commented May 23, 2012

Copy link
Copy Markdown
Member

Okay. Should be fine.

@astrofrog

Copy link
Copy Markdown
Member

@iguananaut - at the same time, could you reorder the front page of the io.fits docs according to the layout in #218, like @mdboom did in #219?

@taldcroft

Copy link
Copy Markdown
Member

@iguananaut - will you be able to move docs/ascii to docs/io/ascii as well? If not I can do this.

@astrofrog

Copy link
Copy Markdown
Member

Note that we may decide in #217 that the docs don't have to mirror the code structure, but I personally think it makes sense to try and mirror it as much as possible, so I think we should move fits, ascii, and vo to an io directory regardless of what happens in #217.

@embray

embray commented May 24, 2012

Copy link
Copy Markdown
Member

Sure, I can do that.

The only holdup right now is that I have a bunch of doc updates for pyfits that I need to merge into Astropy before I start moving things around. I figure it'll be easier that way.

@embray embray mentioned this pull request May 31, 2012
embray added 3 commits June 13, 2012 18:29
… I will want to backport much of these changes to PyFITS--otherwise documentaiton merges will be a nightmare. I like where this new organization is going though.
…and re-added the existing API docs to the main index. automodapi did a pretty decent job, but I still think I prefer the existing organization of the API docs.
@embray

embray commented Jun 14, 2012

Copy link
Copy Markdown
Member

Pretty much reorganized all the astropy.io.fits docs. This is a fairly significant reorg that I will probably want to backport to pyfits sooner rather than later.

I tried automodapi and the output was pretty acceptable. That said, I still prefer the existing organization of pyfits' API docs so I kept that as is.

Otherwise, I made docs/io/fits/index look more like the indexes of the other sub-packages' docs. This involved moving the old "tutorial" section into the "Getting Started" section, which worked out fine.

Barring any further comments I'll go ahead an merge this soon.

@eteq

eteq commented Jun 14, 2012

Copy link
Copy Markdown
Member

This looks fine to me for 0.1.

For 0.2 (or possibly later, because this isn't a big deal) @iguananaut , can you see about deciding what needs to be in automodapi to make it "perfect" for your use? But no rush.

@astrofrog

Copy link
Copy Markdown
Member

Looks good - feel free to merge!

embray added a commit that referenced this pull request Jun 14, 2012
Move `docs/fits` to `docs/io/fits`
@embray
embray merged commit a2e1317 into astropy:master Jun 14, 2012
keflavich pushed a commit to keflavich/astropy that referenced this pull request Oct 9, 2013
Move `docs/fits` to `docs/io/fits`
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.

4 participants