The source code that powers readthedocs.org
Python JavaScript HTML CSS Makefile Batchfile
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Mention RTD in the Project URL of the issue template Apr 9, 2018
.tx added tx config Oct 3, 2012
common @ ae89229 V2 of the configuration file (#4355) Aug 2, 2018
contrib #3718: Added date to changelog (#3788) Mar 29, 2018
docs Slight clarification on turning off ads for a project Aug 16, 2018
logs Put the logs directory in the repo. Mar 12, 2012
media Merge pull request #4424 from rtfd/davidfischer/cloudflare-sponsor-logo Aug 15, 2018
readthedocs Update build assets (#4537) Aug 17, 2018
requirements Remove mailgun from our dependencies (#4531) Aug 17, 2018
scripts/travis fixing travis May 21, 2018
.coveragerc Ignore migrations from coverage report May 24, 2018
.eslintrc Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.flake8 Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.gitattributes Fix woff2 files (#4049) May 3, 2018
.gitignore All static media is run through "collectstatic" Aug 7, 2018
.gitmodules Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.isort.cfg Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.pep8 Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.pre-commit-config.yaml Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.style.yapf Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
.travis.yml Cache ~/.npm to speed up CI Aug 10, 2018
AUTHORS.rst Link to the documentation page for the core team Feb 16, 2018
CHANGELOG.rst Release 2.6.2 Aug 14, 2018
LICENSE Rename License.mit to License Sep 7, 2017
MANIFEST.in Adjust manifest Sep 7, 2017
README.rst Update the sphinx-doc.org links in README Jun 14, 2018
bower.json Update local assets for theme to 0.3.1 tag (#4047) May 1, 2018
conftest.py Extend pytest's `markexpr` conf in case it already exists Jun 28, 2018
fabfile.py fabfile: update i18n helpers Jun 5, 2018
gulpfile.js Updates for the manifest storage Jul 25, 2018
manage.py Settings and public domain restructure (#1829) Apr 14, 2016
package.json Fix issues building static assets Jun 28, 2018
prospector-more.yml Cleaned up remaining code Feb 23, 2018
prospector.yml Drop readthedocs- prefix to submodule (#3916) Apr 6, 2018
pytest.ini Make the donate tests run in CI Sep 26, 2017
requirements.txt Added top-level requirements file Apr 15, 2015
setup.cfg Release 2.6.2 Aug 14, 2018
setup.py Add changelog and changelog automation (#3364) Dec 7, 2017
tasks.py Release 2.3.6 Apr 6, 2018
tox.ini Use "npm run lint" from tox (#4312) Jul 5, 2018

README.rst

Welcome to Read the Docs

build status Documentation Status

Purpose

Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredText, and can pull from your Subversion, Bazaar, Git, and Mercurial repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation.

Documentation for RTD

You will find complete documentation for setting up your project at the Read the Docs site.

Get in touch

You can find information about getting in touch with Read the Docs at our Contribution page.

Contributing

You can find information about contributing to Read the Docs at our Contribution page.

Quickstart for GitHub-Hosted Projects

By the end of this quickstart, you will have a new project automatically updated when you push to GitHub.

  1. Create an account on Read the Docs. You will get an email verifying your email address which you should accept within 7 days.
  2. Log in and click on "Import a Project".
  3. Click "Connect to GitHub" in order to connect your account's repositories to GitHub.
  4. When prompted on GitHub, give access to your account.
  5. Click "Import a Repository" and select any desired repository.
  6. Change any information if desired and click "Next".
  7. All done. Commit away and your project will auto-update.

License

MIT © 2010-2017 Read the Docs, Inc & contributors