Skip to content

Preparing online docs

orbeckst edited this page Apr 25, 2012 · 6 revisions

Maintaining the online docs on github

There are probably better recipes out there to maintain the gh-pages of a project (see Stackoverflow etc...) but for the moment the GromacsWrapper pages are kept up to date with the following protocol.

Have one directory with master/develop to do work and a separate one where the gh-pages branch is checked out.

On master:

  1. edit the docs and commit
  2. generate the sphinx docs
  3. commit docs
  4. push changes

On gh-pages: Destructive/non-history-retaining protocol

git co master  # needed for merging when in separate dir
git pull       # get stuff done in the previous step
git co gh-pages
git co master doc/html
rsync -avP doc/html/ .
git rm -rf doc/
# possibly manually add new files
# git add -a
git ci -a -m 'updated online docs'
git push

Still requires check out of master to do a merge.

Clone this wiki locally