Small typo in IPython developer’s guide

[rougier]

Part "Setup your fork", In "Overview":

git clone git@github.com/your-user-name/ipython.git

The first "/" should be replace by ":"

[takluyver]

I've checked that, and made the change to the sources (since it's trivial, I figured that it makes more sense to get it committed straight away than to worry about someone reviewing the change). The docs will need to be rebuilt and uploaded - does someone want to give me a pointer on the best way to do that? Or is it best just to leave it until there are some other changes to the docs?

[fperez]

No, go ahead and do it yourself. Sorry that we haven't added instructions on this, it's the brand new setup we put in this week.

In the docs/ directory, run (just once) ./gh-pages.py. That will checkout a sub-repo in a directory called gh-pages/. Then run 'make gh-pages'. It should do a build and commit, and leave the gh-pages repo ready for a push. You then just need to look in gh-pages that index.html looks reasonable and if you're happy with the result, 'git push' it.

That should be it. BTW, if you can add these short instructions to the dev guide on a small section on how to handle the docs, that would be great.

[takluyver]

./gh-pages.py gives me:

subprocess.CalledProcessError: Command 'git describe' returned non-zero exit status 128

Running git describe myself gives me:

fatal: No annotated tags can describe 'e372c2f35f9d7f481385ceeb003b0943d4dab56b'.
However, there were unannotated tags: try --tags.

[fperez]

Sorry, if there's no tag you should do

./gh-pages.py Current

or similar, so that it doesn't try to get a tag. We should probably fix the gh-pges script to do that automatically when there's no argument and no tag.

[takluyver]

I'm having more troubles, I'll take this back to the list.

[fperez]

Sorry... I'm also on IRC if you need me, we obviously need to smooth this out a little bit more :)

[takluyver]

The typo is now well and truly fixed.