Page History
...
Code Block |
---|
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 tomypackage/doc/web
and edit Makefile, fonf.py and index.rst files.
Generate documentation
After staging or committing code changes
Code Block |
---|
cd doc/web
make newdoc |
Change GitHub Pages settings
...
- https://lcls-psana.github.io/psalgos/
- https://lcls-psana.github.io/PSCalib/
- https://lcls-psana.github.io/Detector/
References
- http://lucasbardella.com/blog/2010/02/hosting-your-sphinx-docs-in-github
- https://daler.github.io/sphinxdoc-test/includeme.html
- https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
- https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
Overview
Content Tools