V2 TODO

[Eric Holscher]

I basically re-wrote the complete rtd-build cli.
Here is a current backlog of open tasks:

• reading readthedocs.yml configs
• rtd-build cli
• running build inside a virtualenv
• building html docs using sphinx
• sphinx json output for search (will be placed in the search_data directory)
• support for virtualenv's --system-site-packages
• support for requirements.txt
• support for python setup.py install
• defaulting to sphinx_rtd_theme
• sphinx dirhtml support
• sphinx singlehtml support (and local media build)
• sphinx pdf support
• sphinx epub support
• auto-create index.html file if none exists
• mkdocs support
• awesome logging
• remove .doctree files from output

All implemented things are tested very well. Tests can be run with tox. Instructions in the README have been updated.

To run a quick sample of the builder, do:

cd integration_tests/minimal_project/
rtd-build

This will output the rendered docs in _readthedocs_build/docs/html/.

Currently we support the following config options in readthedocs.yml:

name: docs  # required, arbitrary
type: sphinx  # required, only sphinx is supported at the moment
base: docs-en/  # the base directory of the source files

Continued from #6