Skip to content
This repository has been archived by the owner on Apr 18, 2018. It is now read-only.

Latest commit

 

History

History
15 lines (9 loc) · 908 Bytes

README.md

File metadata and controls

15 lines (9 loc) · 908 Bytes

Write the Docs website

This is the code that powers www.writethedocs.org. It contains information about the Write the Docs group, as well as information about writing documentation.

The repo is still in its early stages; feel free to contribute information that you might want to share with the community. To contribute to the Write the Docs website, famililarize yourself with the Sphinx site generator.

Run pip install -r requirements.txt to install everything you need to generate the site locally.

Run make html in the docs directory to generate a local version of the site in docs/_build/html/.

The Write the Docs website is hosted on Read the Docs.

We develop documentation on a dev branch, which is rendered at http://writethedocs-www.readthedocs.org/en/dev/.