https://github.com/rtfd/readthedocs.org

The source code that powers readthedocs.org
https://github.com/rtfd/readthedocs.org

docs mkdocs python sphinx sphinx-doc

Last synced: 3 months ago
JSON representation

The source code that powers readthedocs.org

• Host: GitHub
• URL: https://github.com/rtfd/readthedocs.org
• Owner: readthedocs
• License: mit
• Created: 2010-08-16T19:18:06.000Z (about 14 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T21:58:13.000Z (5 months ago)
• Last Synced: 2024-05-22T23:48:22.714Z (5 months ago)
• Topics: docs, mkdocs, python, sphinx, sphinx-doc
• Language: Python
• Homepage: https://readthedocs.org/
• Size: 108 MB
• Stars: 7,892
• Watchers: 249
• Forks: 3,575
• Open Issues: 394
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: .github/CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• starred-awesome - readthedocs.org - The source code that powers readthedocs.org (Python)

README

        
Welcome to Read the Docs

========================

|build-status| |docs| |coverage|

Purpose

-------

`Read the Docs`_ hosts documentation for the open source community.

It supports many documentation tools

(e.g. Sphinx_ docs written with reStructuredText_, MkDocs_ docs written with markdown_, among others),

and can pull Git_ repositories.

Then we build documentation and host it for you.

Think of it as *Continuous Documentation*, or Docs as Code.

.. _Read the docs: https://readthedocs.org/

.. _Sphinx: http://www.sphinx-doc.org/

.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

.. _Git: http://git-scm.com/

.. _MkDocs: https://www.mkdocs.org/

.. _markdown: https://daringfireball.net/projects/markdown/

Documentation for Read the Docs

-------------------------------

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 `_.

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.

#. Create an account on `Read the Docs`_ by signing up with GitHub.

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

#. Log in and click on "Add project".

#. Start typing the name of your repository and select it from the list,

   and click "Continue".

#. 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/main/graph/badge.svg

    :alt: Test coverage

    :scale: 100%

    :target: https://codecov.io/gh/readthedocs/readthedocs.org

License

-------

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

.. _MIT: LICENSE