Read the Docs

By Jack Henderson

In this tutorial...

In this article:

Prerequisites

Before you start, make sure...

Note

For additional information...

Create the Docs and Add to Github

signup for a github account Github.

create new repository for Docs in github.

../_images/0115-.png ../_images/0120-.png

Clone Docs using Github desktop app

../_images/0140-.png ../_images/0150-.png

Create branch

../_images/0160-.png ../_images/0173-.png ../_images/0180-.png ../_images/0200-.png ../_images/0210-.png

Erase _build directory

../_images/0215-.png

Copy the new doc stuff we created earlier

../_images/0220-.png

commit

../_images/0221-.png

pull request

../_images/0222-.png

merge

../_images/0223-.png

Add the Project to Readthedocs

signup for a readthedocs.org account https://readthedocs.org connect readthedocs to github account https://readthedocs.org/accounts/social/connections

../_images/0230-.png ../_images/0240-.png ../_images/0250-.png ../_images/0260-.png

import doc into readthedocs.org

../_images/0300-.png ../_images/0310-.png

remember to set the location of the config file: fasterpace/conf.cy

https://readthedocs.org/dashboard/ choose Import a project http://docs.readthedocs.org/en/latest/getting_started.html