Jukoro documentation using Sphinx

Update. jukoro library has been moved to archive, no plans to develop it further.

Summary about creating python library documentation using Sphinx and publishing it to GitHub Pages (based on this article).

$ git clone git@github.com:ysegorov/jukoro.git
$ cd jukoro

$ mkdir docs
$ pip install sphinx
$ sphinx-apidoc -A "Yuri Egorov" -F -o docs jukoro

$ git add docs
$ git commit -m "sphinx-apidoc generated docs folder contents"

$ mkdir gh-pages
$ vim docs/Makefile  ## change BUILDDIR to ../gh-pages

$ /usr/share/git/workdir/git-new-workdir . gh-pages/html
$ cd gh-pages/html

$ git checkout --orphan gh-pages
$ git rm -rf .

$ cd ../../docs
$ make html
$ cd -

$ git add .
$ git commit -m "sphinx generated docs"
$ git push -u origin gh-pages

$ touch .nojekyll  ## to skip Jekyll
$ git add .nojekyll
$ git commit -m ".nojekyll"
$ git push

And now there is jukoro's documentation available online (still requires some attention).

For some reason I've started to use markdown for readme and changelog files but now it seems it would be better to use reStructuredText.

This way it will be possible to include readme and changelog to documentation (which is not finished yet).

Last modified: 2015-04-01 10:40:00 +00:00 UTC