This git repository contains all the generated SymPy documentation. It is hosted at http://docs.sympy.org/ automatically by github.
To build the docs in SymPy, cd into the SymPy clone, and do
cd doc
make clean
make html
Then the built docs are in _build/html. To update the docs here, there are
several things.
These are the easiest. Just build the docs from the latest SymPy master. Then, do
rm -rf dev/
cp -R ../path/to/sympy/doc/_build/html dev/
Then
git add -A dev/
Finally, you need to make sure the index of the different docs on the the left of index.html remains intact. Run
./generate_indices.py
This is harder, because you have to update the index. Checkout the SymPy release tag and build the docs as above. Then do
cp -R ../path/to/sympy/doc/_build/html 0.7.3 # Replace 0.7.3 with the release number
Edit releases.txt with the new release. Then run
./generate_indices.py
Also, you need to update the redirect in index.py. Just edit the file and
change the version number.
Finally, you need to update the latest page. This is easy. Just run
./generate_redirects.py 0.7.3 latest, and commit the changes.
The Python 3 docs are done the same way as the regular docs. They are just built from the Python 3 source. Just do
./bin/use2to3
in the SymPy source first. Note, you will need to install the Python 3
version of Sphinx to get the correct results (otherwise, it may include the
wrong version of the source code for the "show source" extension). Copy the
docs here under the same name, only with -py3k appended.
If you are making a significant change to the documentation in a pull request,
feel free to use this site to upload a live version of it. Just create a
directory with a reasonable name and put your docs there. If you share the
link with a lot of people before the pull request is merged, you might want to
sue the generate_redirects.py script to convert the special directory into a
redirect to dev once the pull request is merged.
Just push the branch up to GitHub. The pages will be updated automatically. If you don't have push access, fork this repo and make a pull request.
If you want to write a script to automate some or all of this process, that would be great. Just send a pull request. The script should probably go in the SymPy repo, as part of the build script for the release process.