Importing docs on Read the Docs

Read the Docs hosts documentation for Open Source Projects. They support Sphinx docs written with reStructuredText and CommonMark. They build documentation by pulling our code from Subversion, Bazaar, Git, or Mercurial repositories and host it.

Before importing a repository you need to sign up and connect an external account such as GitHub or Bitbucket. Connecting your account allows for easier importing and enables Read the Docs to configure your repository webhooks automatically.

Importing Docs

To import a repository visit your dashboard and click Import. If you have a connected account, a list of your repositories will be shown from which you can import a repository by clicking the import icon next to it.

If you do not have a connected account or if the repository you want to import doesn’t show up in the list, you can click on Import Manually and enter the information of the repository yourself. You will be asked for the project name, repository URL and repository type for your new project.

Screenshot from 2017-07-26 21:06:02.png

In the next step, you will be asked for a description of the project, documentation type, language, programming language, project homepage and tags.

Screenshot from 2017-07-26 21:14:09.png

Screenshot from 2017-07-26 21:14:20.png

After filling up and submitting the form your project will be created. Within a few seconds your code will automatically be fetched from your public repository, and the documentation will be built.

Hosting docs of GraphSpace Python library on RTD

After creating the project for GraphSpace Python library in RTD, it needs to be installed inside a virtualenv using setup.py install before documentation can be built. There is an option for this in the Advanced Settings under Admin tab of the project. This can be done by checking the Install Project option and specifying the Requirements File.

Screenshot from 2017-07-26 21:30:41.png

Read the Docs can also host multiple versions of your code. For that you can go to the Versions section under Admin tab of your project and chose the default and active versions for your project and also you can edit them. You can read more about how to use this well on the Versions documentation page.

One thought on “Importing docs on Read the Docs

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s