You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
David Fischer 3633a1fde3
Merge pull request #7716 from readthedocs/davidfischer/ensure-space-for-ad
11 hours ago
.circleci Use only 2 jobs 1 month ago
.github Silent curl (#6377) 1 year ago
.tx added tx config 8 years ago
common @ cba60512f6 Bump common to include docker task changes 1 month ago
contrib Remove unused file 10 months ago
dockerfiles Add settings and docker configuration for working with new theme 1 month ago
docs Automation rules: add delete version action (#7644) 2 weeks ago
logs Put the logs directory in the repo. 8 years ago
media Re-add the keep us sustainable block 1 month ago
readthedocs Ensure there is space for sidebar ads 13 hours ago
requirements Update sphinx from 3.3.0 to 3.3.1 2 weeks ago
scripts/circle CI: use circleci 1 month ago
.codecov.yml Disable diff coverage status 1 year ago
.coveragerc Ignore six.PY2 from coverage 2 years ago
.dockerignore Simplify docker image 10 months ago
.env Move common configs to common repository 10 months ago
.eslintrc Drop readthedocs- prefix to submodule (#3916) 2 years ago
.flake8 Drop readthedocs- prefix to submodule (#3916) 2 years ago
.gitattributes fix gif image 1 year ago
.gitignore Rename docker settings to fix local environment 9 months ago
.gitmodules change rtfd to readthedocs(#5870) 1 year ago
.isort.cfg Drop readthedocs- prefix to submodule (#3916) 2 years ago
.pep8 Drop readthedocs- prefix to submodule (#3916) 2 years ago
.pre-commit-config.yaml Drop readthedocs- prefix to submodule (#3916) 2 years ago
.pyup.yml pyup.yml syntax fixed 1 year ago
.readthedocs.yml Search: exclude chagelog from results 1 month ago
.style.yapf Drop readthedocs- prefix to submodule (#3916) 2 years ago
AUTHORS.rst DOC: Change a lot of http links to https 10 months ago
CHANGELOG.rst Release 5.6.5 1 week ago
LICENSE Update LICENSE 1 year ago
MANIFEST.in Adjust manifest 3 years ago
README.rst CI: use badge from circleci 1 month ago
bower.json change rtfd to readthedocs(#5870) 1 year ago
docker-compose.override.yml Revert "Use requests.head to query storage.exists" 7 months ago
gulpfile.js Move js to a file 1 year ago
manage.py Settings and public domain restructure (#1829) 4 years ago
package-lock.json No longer proxy RTD ads through RTD servers 2 months ago
package.json Release 5.6.4 2 weeks ago
prospector-more.yml CI: fix linter (#7261) 4 months ago
prospector.yml Drop readthedocs- prefix to submodule (#3916) 2 years ago
pytest.ini Remove ignore warning 6 months ago
requirements.txt Added top-level requirements file 5 years ago
setup.cfg Release 5.6.5 1 week ago
setup.py Add changelog and changelog automation (#3364) 3 years ago
tasks.py container_prefix 10 months ago
tox.ini CI: use circleci 1 month ago

README.rst

Welcome to Read the Docs
========================

|build-status| |docs| |coverage|

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*.

.. _Read the docs: https://readthedocs.org/
.. _Sphinx: http://www.sphinx-doc.org/
.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _Subversion: http://subversion.tigris.org/
.. _Bazaar: http://bazaar.canonical.com/
.. _Git: http://git-scm.com/
.. _Mercurial: https://www.mercurial-scm.org/

Documentation for RTD
---------------------

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

.. _the Read the Docs site: https://docs.readthedocs.io/

Get in touch
------------

You can find information about getting in touch with Read the Docs at our `Contribution page <https://docs.readthedocs.io/en/latest/contribute.html#get-in-touch>`_.

Contributing
------------

You can find information about contributing to Read the Docs at our `Contribution page <https://docs.readthedocs.io/en/latest/contribute.html>`_.

Quickstart for GitHub-Hosted Projects
-------------------------------------

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

#. Create an account on `Read the Docs`_. You will get an email verifying your
email address which you should accept within 7 days.

#. Log in and click on "Import a Project".

#. Click "Connect to GitHub" in order to connect your account's repositories to GitHub.

#. When prompted on GitHub, give access to your account.

#. Click "Import a Repository" and select any desired repository.

#. Change any information if desired and click "Next".

#. All done. Commit away and your project will auto-update.


.. |build-status| image:: https://circleci.com/gh/readthedocs/readthedocs.org.svg?style=svg
:alt: build status
:target: https://circleci.com/gh/readthedocs/readthedocs.org

.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://docs.readthedocs.io/en/latest/?badge=latest

.. |coverage| image:: https://codecov.io/gh/readthedocs/readthedocs.org/branch/master/graph/badge.svg
:alt: Test coverage
:scale: 100%
:target: https://codecov.io/gh/readthedocs/readthedocs.org

License
-------

`MIT`_ © 2010-2020 Read the Docs, Inc & contributors

.. _MIT: LICENSE