cpython/Doc at main · python/cpython · GitHub Skip to content Navigation Menu Sign in Appearance settings * Platform * AI CODE CREATION * GitHub Copilot Write better code with AI * GitHub Copilot app Direct agents from issue to merge * MCP Registry Integrate external tools * DEVELOPER WORKFLOWS * Actions Automate any workflow * Codespaces Instant dev environments * Issues Plan and track work * Code Review Manage code changes * Code Quality Enforce quality at merge * APPLICATION SECURITY * GitHub Advanced Security Find and fix vulnerabilities * Code security Secure your code as you build * Secret protection Stop leaks before they start * EXPLORE * Why GitHub * Documentation * Blog * Changelog * Marketplace View all features * Solutions * BY COMPANY SIZE * Enterprises * Small and medium teams * Startups * Nonprofits * BY USE CASE * App Modernization * DevSecOps * DevOps * CI/CD * View all use cases * BY INDUSTRY * Healthcare * Financial services * Manufacturing * Government * View all industries View all solutions * Resources * EXPLORE BY TOPIC * AI * Software Development * DevOps * Security * View all topics * EXPLORE BY TYPE * Customer stories * Events & webinars * Ebooks & reports * Business insights * GitHub Skills * SUPPORT & SERVICES * Documentation * Customer support * Community forum * Trust center * Partners View all resources * Open Source * COMMUNITY * GitHub Sponsors Fund open source developers * PROGRAMS * Security Lab * Maintainer Community * GitHub Stars * Archive Program * REPOSITORIES * Topics * Trending * Collections * Enterprise * ENTERPRISE SOLUTIONS * Enterprise platform AI-powered developer platform * AVAILABLE ADD-ONS * GitHub Advanced Security Enterprise-grade security features * Copilot for Business Enterprise-grade AI features * Premium Support Enterprise-grade 24/7 support * Pricing 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 . python / cpython Public * Uh oh! There was an error while loading. Please reload this page . * Notifications You must be signed in to change notification settings * Fork 35.4k * Star 76.8k * Code * Issues 5k+ * Pull requests 2.6k * Actions * Projects * Security and quality 0 * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Security and quality * Insights Files Expand file tree main Breadcrumbs * cpython / Doc / Copy path Directory actions More options More options Directory actions More options More options Latest commit   History History History main Breadcrumbs * cpython / Doc / Copy path Top Folders and files Name Name Last commit message Last commit date parent directory .. _static _static     c-api c-api     data data     deprecations deprecations     distributing distributing     extending extending     faq faq     howto howto     includes includes     installing installing     library library     reference reference     tools tools     tutorial tutorial     using using     whatsnew whatsnew     .ruff.toml .ruff.toml     Makefile Makefile     README.rst README.rst     about.rst about.rst     bugs.rst bugs.rst     conf.py conf.py     constraints.txt constraints.txt     contents.rst contents.rst     copyright.rst copyright.rst     glossary.rst glossary.rst     improve-page-nojs.rst improve-page-nojs.rst     improve-page.rst improve-page.rst     license.rst license.rst     make.bat make.bat     pylock.toml pylock.toml     requirements.txt requirements.txt     View all files README.rst Outline Python Documentation README This directory contains the reStructuredText (reST) sources to the Python documentation. You don't need to build them yourself, prebuilt versions are available . Documentation on authoring Python documentation, including information about both style and markup, is available in the " Documenting Python " chapter of the developers guide. Building the docs The documentation is built with several tools which are not included in this tree but are maintained separately and are available from PyPI . * Sphinx * blurb * python-docs-theme The easiest way to install these tools is to create a virtual environment and install the tools into there. Using make To get started on Unix, you can create a virtual environment and build documentation with the commands: make venv make html The virtual environment in the venv directory will contain all the tools necessary to build the documentation downloaded and installed from PyPI. If you'd like to create the virtual environment in a different location, you can specify it using the VENVDIR variable. You can also skip creating the virtual environment altogether, in which case the Makefile will look for instances of sphinx-build and blurb installed on your process PATH (configurable with the SPHINXBUILD and BLURB variables). On Windows, we try to emulate the Makefile as closely as possible with a make.bat file. If you need to specify the Python interpreter to use, set the PYTHON environment variable. Available make targets are: * "clean", which removes all build files and the virtual environment. * "clean-venv", which removes the virtual environment directory. * "venv", which creates a virtual environment with all necessary tools installed. * "html", which builds standalone HTML files for offline viewing. * "htmlview", which re-uses the "html" builder, but then opens the main page in your default web browser. * "htmllive", which re-uses the "html" builder, rebuilds the docs, starts a local server, and automatically reloads the page in your browser when you make changes to reST files (Unix only). * "htmlhelp", which builds HTML files and a HTML Help project file usable to convert them into a single Compiled HTML (.chm) file -- these are popular under Microsoft Windows, but very handy on every platform. To create the CHM file, you need to run the Microsoft HTML Help Workshop over the generated project (.hhp) file. The make.bat script does this for you on Windows. * "latex", which builds LaTeX source files as input to pdflatex to produce PDF documents. * "text", which builds a plain text file for each source file. * "epub", which builds an EPUB document, suitable to be viewed on e-book readers. * "linkcheck", which checks all external references to see whether they are broken, redirected or malformed, and outputs this information to stdout as well as a plain-text (.txt) file. * "changes", which builds an overview over all versionadded/versionchanged/ deprecated items in the current version. This is meant as a help for the writer of the "What's New" document. * "coverage", which builds a coverage overview for standard library modules and C API. * "pydoc-topics", which builds a Python module containing a dictionary with plain text documentation for the labels defined in tools/pyspecific.py -- pydoc needs these to show topic and keyword help. * "check", which checks for frequent markup errors. * "dist", (Unix only) which creates distributable archives of HTML, text, PDF, and EPUB builds. Without make First, install the tool dependencies from PyPI. Then, from the Doc directory, run sphinx-build -b<builder> . build/<builder> where <builder> is one of html, text, latex, or htmlhelp (for explanations see the make targets above). Deprecation header You can define the outdated variable in html_context to show a red banner on each page redirecting to the "latest" version. The link points to the same page on /3/ , sadly for the moment the language is lost during the process. Contributing Bugs in the content should be reported to the Python bug tracker . Bugs in the toolset should be reported to the tools themselves. To help with the documentation, or report any problems, please leave a message on discuss.python.org . Footer (c) 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.