Page History

...

cd ../../../mypackage-doc/html
git branch # make sure that it is * gh-pages
git status
git add -A
git commit -m "add/update doc"
git push origin gh-pages

Shortcut for commands above.

Setup package structure to generate documentation

• TBD - need in script which creates sphinx configuration files (equivalent to sphinx-quickstart) but with significantly extended Makefile.

• For now copy psalgos/doc/web directory to mypackage/doc/web and edit Makefile, fonf.py and index.rst files.

Generate documentation

After staging or committing code changes

cd doc/web
make newdoc

Change GitHub Pages settings

...