入门

It’s really easy to start using RTD for your project’s documentation. This section shows you how.

If you are already using Sphinx for your docs, skip ahead to 导入文档.

撰写文档

Install Sphinx, and create a directory inside your project to hold your docs:

$ cd /path/to/project
$ mkdir docs

Run sphinx-quickstart in there:

$ cd docs
$ sphinx-quickstart

This will walk you through creating the basic configuration; in most cases, you can just accept the defaults. When it’s done, you’ll have an index.rst, a conf.py and some other files. Add these to revision control.

Now, edit your index.rst and add some information about your project. Include as much detail as you like (refer to the reStructuredText syntax if you need help). Build them to see how they look:

$ make html

Edit and rebuild until you like what you see, then commit and/or push your changes to your public repository.

导入文档

Sign up for an account and log in. Visit your dashboard and click Import to add your project to the site. Fill in the name and description, then specify where your repository is located. This is normally the URL or path name you’d use to checkout, clone, or branch your code. Some examples:

  • Git: http://github.com/ericholscher/django-kong.git
  • Subversion: http://varnish-cache.org/svn/trunk
  • Mercurial: https://bitbucket.org/ianb/pip
  • Bazaar: lp:pasta

Add an optional homepage URL and some keywords, then click “Create”.

Within a few minutes your code will automatically be fetched from your public repository, and the documentation will be built.

If you want to keep your code updated as you commit, configure your code repository to hit our Post Commit Hooks. Otherwise your project will get rebuilt nightly.

Read the Docs v: latest
Versions
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.