    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.

              sphinx-doc / sphinx Public

                      * Uh oh!

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

              * Notifications You must be signed in to change notification settings
              * Fork 2.5k
                * Star 8k
          * Code
          * Issues 1.3k
          * Pull requests 205
          * Discussions
          * Actions
          * Projects
          * Security and quality 0
          * Insights
          Additional navigation options
                  * Code
                  * Issues
                  * Pull requests
                  * Discussions
                  * Actions
                  * Projects
                  * Security and quality
                  * Insights
                                              master
                                          Branches Tags
                                            Go to file
                                        Code
                                          Open more actions menu

                                        Folders and files

                                          Name                            Name                              Last commit message    Last commit date
                                            Latest commit               
                                                                        
                                                History                 
                                                                        
                                                22,413 Commits          
                                                  22,413 Commits        
                                                  .github                         .github                                                          
                                                  doc                             doc                                                              
                                                  sphinx                          sphinx                                                           
                                                  tests                           tests                                                            
                                                  utils                           utils                                                            
                                                  .codecov.yml                    .codecov.yml                                                     
                                                  .git-blame-ignore-revs          .git-blame-ignore-revs                                           
                                                  .gitattributes                  .gitattributes                                                   
                                                  .gitignore                      .gitignore                                                       
                                                  .mailmap                        .mailmap                                                         
                                                  .prettierrc.toml                .prettierrc.toml                                                 
                                                  .pytest.toml                    .pytest.toml                                                     
                                                  .readthedocs.yml                .readthedocs.yml                                                 
                                                  .ruff.toml                      .ruff.toml                                                       
                                                  AUTHORS.rst                     AUTHORS.rst                                                      
                                                  CHANGES.rst                     CHANGES.rst                                                      
                                                  CODE_OF_CONDUCT.rst             CODE_OF_CONDUCT.rst                                              
                                                  CONTRIBUTING.rst                CONTRIBUTING.rst                                                 
                                                  EXAMPLES.rst                    EXAMPLES.rst                                                     
                                                  LICENSE.rst                     LICENSE.rst                                                      
                                                  Makefile                        Makefile                                                         
                                                  README.rst                      README.rst                                                       
                                                  bindep.txt                      bindep.txt                                                       
                                                  package-lock.json               package-lock.json                                                
                                                  package.json                    package.json                                                     
                                                  pyproject.toml                  pyproject.toml                                                   
                                                  pyrefly.toml                    pyrefly.toml                                                     
                                                  tox.ini                         tox.ini                                                          
                                                  ty.toml                         ty.toml                                                          
                                                  uv.lock                         uv.lock                                                          
                                            View all files              
                                          

                                              Repository files navigation

                                                * 
                                                * README
                                                * Contributing
                                                * License
                                                More items

                                                Sphinx

                                              Sphinx makes it easy to create intelligent and beautiful documentation.

                                              Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

                                                Features

                                                * Output formats: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
                                                * Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information
                                                * Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
                                                * Automatic indices: general index as well as a module index
                                                * Code highlighting: automatic highlighting using the Pygments highlighter
                                                * Templating: Flexible HTML output using the Jinja 2 templating engine
                                                * Extension ecosystem: Many extensions are available, for example for automatic function documentation or working with Jupyter notebooks.
                                                * Language Support: Python, C, C++, JavaScript, mathematics, and many other languages through extensions.

                                              For more information, refer to the documentation.

                                                Installation

                                              The following command installs Sphinx from the Python Package Index. You will need a working installation of Python and pip.

                                                pip install -U sphinx

                                                Contributing

                                              We appreciate all contributions! Refer to the contributors guide for information.

                                        About

                                        The Sphinx documentation generator

                                          www.sphinx-doc.org/

                                        Topics

                                          docsdocumentationdocumentation-toolmarkdownpythonrestructuredtextsphinx

                                        Resources

                                          Readme
                                          License

                                        Contributing

                                          Contributing
                                          Activity
                                          Custom properties

                                        Stars

                                          8.0k stars

                                        Watchers

                                          175 watching

                                        Forks

                                          2.5k forks
                                          Report repository

                                        Releases

                                        Sponsor this project

                                        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.