[guide] Updating documentation

Note: These instructions are out of date. Run make update_docs instead

The sphinx-generated documentation is published to http://op2.github.com/PyOP2/ this currently requires manual intervention.

Documentation is published using the gh-pages branch mechanism. To make this a bit easier to use, we use a git submodule to store the branch.

To make everything work: In the PyOP2 repo:

• git submodule init
• git submodule update

The documentation is stored in a directory .site in the top-level.

To update the documentation. Build as normal in doc/sphinx. Copy the generated docs into .site. Switch into .site and add and commit the changes and push them. This will push the submodule changes (i.e. just the gh-pages branch). Now switch into the top-level directory. Note how the tree is dirty (because the submodule has updated). Add this change (git add .site) and commit and push.

Remember to do this final commit so that when you clone the repo the generated docs that appear are in line with the current commit.