    Skip to content

      Navigation Menu

            Sign in Appearance settings
                * Platform
                        + AI CODE CREATION
                            o GitHub Copilot Write better code with AI
                            o GitHub Copilot app Direct agents from issue to merge
                            o MCP Registry Integrate external tools
                        + DEVELOPER WORKFLOWS
                            o Actions Automate any workflow
                            o Codespaces Instant dev environments
                            o Issues Plan and track work
                            o Code Review Manage code changes
                            o Code Quality Enforce quality at merge
                        + APPLICATION SECURITY
                            o GitHub Advanced Security Find and fix vulnerabilities
                            o Code security Secure your code as you build
                            o Secret protection Stop leaks before they start
                        + EXPLORE
                            o Why GitHub
                            o Documentation
                            o Blog
                            o Changelog
                            o Marketplace
                      View all features
                * Solutions
                        + BY COMPANY SIZE
                            o Enterprises
                            o Small and medium teams
                            o Startups
                            o Nonprofits
                        + BY USE CASE
                            o App Modernization
                            o DevSecOps
                            o DevOps
                            o CI/CD
                            o View all use cases
                        + BY INDUSTRY
                            o Healthcare
                            o Financial services
                            o Manufacturing
                            o Government
                            o View all industries
                      View all solutions
                * Resources
                        + EXPLORE BY TOPIC
                            o AI
                            o Software Development
                            o DevOps
                            o Security
                            o View all topics
                        + EXPLORE BY TYPE
                            o Customer stories
                            o Events & webinars
                            o Ebooks & reports
                            o Business insights
                            o GitHub Skills
                        + SUPPORT & SERVICES
                            o Documentation
                            o Customer support
                            o Community forum
                            o Trust center
                            o Partners
                      View all resources
                * Open Source
                        + COMMUNITY
                            o GitHub Sponsors Fund open source developers
                        + PROGRAMS
                            o Security Lab
                            o Maintainer Community
                            o Accelerator
                            o GitHub Stars
                            o Archive Program
                        + REPOSITORIES
                            o Topics
                            o Trending
                            o Collections
                * Enterprise
                        + ENTERPRISE SOLUTIONS
                            o Enterprise platform AI-powered developer platform
                        + AVAILABLE ADD-ONS
                            o GitHub Advanced Security Enterprise-grade security features
                            o Copilot for Business Enterprise-grade AI features
                            o Premium Support Enterprise-grade 24/7 support
              * Pricing
                Type / to search
                Sign in
              Sign up Appearance settings
      You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

              Uh oh!

              There was an error while loading. Please reload this page.

              readthedocs / readthedocs.org Public

                      * Uh oh!

                        There was an error while loading. Please reload this page.

              * Notifications You must be signed in to change notification settings
              * Fork 3.7k
                * Star 8.4k
          * Code
          * Issues 328
          * Pull requests 80
          * Actions
          * Projects
          * Security and quality 29
          * Insights
          Additional navigation options
                  * Code
                  * Issues
                  * Pull requests
                  * Actions
                  * Projects
                  * Security and quality
                  * Insights
                                              main
                                          Branches Tags
                                            Go to file
                                        Code
                                          Open more actions menu

                                        Folders and files

                                          Name                                 Name                                   Last commit message    Last commit date
                                            Latest commit                    
                                                                             
                                                History                      
                                                                             
                                                21,581 Commits               
                                                  21,581 Commits             
                                                  .circleci                            .circleci                                                             
                                                  .claude                              .claude                                                               
                                                  .github                              .github                                                               
                                                  .tx                                  .tx                                                                   
                                                  common @ 81dd014                     common @ 81dd014                                                      
                                                  dockerfiles                          dockerfiles                                                           
                                                  docs                                 docs                                                                  
                                                  logs                                 logs                                                                  
                                                  media                                media                                                                 
                                                  readthedocs                          readthedocs                                                           
                                                  requirements                         requirements                                                          
                                                  scripts                              scripts                                                               
                                                  .codecov.yml                         .codecov.yml                                                          
                                                  .coveragerc                          .coveragerc                                                           
                                                  .dockerignore                        .dockerignore                                                         
                                                  .env                                 .env                                                                  
                                                  .git-blame-ignore-revs               .git-blame-ignore-revs                                                
                                                  .gitattributes                       .gitattributes                                                        
                                                  .gitignore                           .gitignore                                                            
                                                  .gitmodules                          .gitmodules                                                           
                                                  .pre-commit-config.yaml              .pre-commit-config.yaml                                               
                                                  .readthedocs.yml                     .readthedocs.yml                                                      
                                                  .ruff.toml                           .ruff.toml                                                            
                                                  .vale.ini                            .vale.ini                                                             
                                                  AGENTS.md                            AGENTS.md                                                             
                                                  AUTHORS.rst                          AUTHORS.rst                                                           
                                                  CHANGELOG.rst                        CHANGELOG.rst                                                         
                                                  LICENSE                              LICENSE                                                               
                                                  MANIFEST.in                          MANIFEST.in                                                           
                                                  README.rst                           README.rst                                                            
                                                  SECURITY.md                          SECURITY.md                                                           
                                                  docker-compose.override.yml          docker-compose.override.yml                                           
                                                  manage.py                            manage.py                                                             
                                                  pytest.ini                           pytest.ini                                                            
                                                  requirements.txt                     requirements.txt                                                      
                                                  setup.cfg                            setup.cfg                                                             
                                                  setup.py                             setup.py                                                              
                                                  tasks.py                             tasks.py                                                              
                                                  tox.embedapi.ini                     tox.embedapi.ini                                                      
                                                  tox.ini                              tox.ini                                                               
                                            View all files                   
                                          

                                              Repository files navigation

                                                * 
                                                * README
                                                * Contributing
                                                * MIT license
                                                * Security
                                                More items

                                                Welcome to Read the Docs

                                                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.

                                                Documentation for Read the Docs

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

                                                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 by signing up with GitHub.
                                               2. When prompted on GitHub, give access to your account.
                                               3. Log in and click on "Add project".
                                               4. Start typing the name of your repository and select it from the list, and click "Continue".
                                               5. Change any information if desired and click "Next".
                                               6. All done. Commit away and your project will auto-update.

                                                License

                                              MIT © 2025 Read the Docs, Inc. & contributors

                                        About

                                        The source code that powers readthedocs.org

                                          readthedocs.org/

                                        Topics

                                          docsmkdocspythonsphinxsphinx-doc

                                        Resources

                                          Readme
                                          MIT license

                                        Contributing

                                          Contributing

                                        Security policy

                                          Security policy
                                          Activity
                                          Custom properties

                                        Stars

                                          8.4k stars

                                        Watchers

                                          240 watching

                                        Forks

                                          3.7k forks
                                          Report repository

                                        Releases

                                        Sponsor this project

                                        Packages

                                        Used by

                                        Contributors

                                        Languages

    Footer

        © 2026 GitHub, Inc.

      Footer navigation

        * Terms
        * Privacy
        * Security
        * Status
        * Community
        * Docs
        * Contact
        * Manage cookies
        * Do not share my personal information
      You can’t perform that action at this time.