Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Docs build #273
Based on my experience of building the docs, here's a brief description in the docs of how to do it (I've checked that it builds OK as html). I've also added a fallback to the gh-pages.py script, so it doesn't crash in the absence of a named tag.
I think the main thing to check is: is the description of the process I've given in the docs sufficient? Is there anyone who's not previously built the docs who's willing to try following these instructions, to see if it's clear enough?
The changes look good, go ahead with the merge. And about */-: just have a quick look throughout, if indeed we had been consistently using *, then might as well not break that. But if we were using both (quite possible, since reST is ok with both), then don't worry.
Actually I think we could just do away with the automatic adding of a line to the index that I had in datarray. While convenient there, for quick and short releases, in IPython I think we're better off just rebuilding the -dev docs by default, and calling the script manually for a release build. In the case of a release, it's no big burden to add manually the extra link.
This would simplify both the code and the usage, since the index.rst page would be fully manually edited, and the script would be limited to one of two actions:
Anyone wanting to have a stab at it, go for it :)
This comment has been minimized.
This comment has been minimized.Show comment Hide comment
I had been thinking of manually specifying the tag in the Makefile, but I will use your dev default, so it can still be used to build other releases from the Makefile without directly calling gh-pages.py.
The note was already in error, because it wasn't possible to create a duplicate release line if you used the correct makefile command (currently 'gh-pages-current', but will be 'gh-pages' after the fix) for the dev docs. I will update the doc page to match.
Thanks for the note.