2016-pycon-tutorial

2016-pycon-tutorial copied to clipboard

• [ ] Show reST documentation again on github -- library and command-line
• [ ] Mention GitHub rendering! Motivate sphinx/RTD.
• [ ] Goals of using sphinx: table of contents, search;
• [ ] Goals of using readthedocs: automatic update; multiple versions;

Running sphinx:

Following instructions in Sphinx first steps,

• [ ] in the doc/ directory of your github checkout, run sphinx-quickstart
• [ ] Answer 'y' to autodoc and doctest and viewcode
• [ ] After it's done, run 'make html'
• [ ] Visit _build/html/index.html in your browser
• [ ] Anatomy of sphinx: combines .rst files into a single document or site; needs an index to bind things together.
• [ ] Edit index.rst, below :maxdepth: put a new line and then add library and command-line (indented, each on separate line)
• [ ] Save, type 'make html' again
• [ ] revel in your nifty new integrated documentation!
• [ ] commit & push to github, with

git add index.rst Makefile make.bat conf.py _static _templates
git commit -am "added sphinx docs"
git push -u origin master

to put onto readthedocs

Log into readthedocs; import project; select project; build.