Documentation

• Getting started
  • Introduction
  • Building the documentation
    • Create a virtual environment
    • Build using make / make.bat
    • Build using Sphinx directly
• Helping with documentation
  • Python documentation
  • Helping with documentation issues
  • Proofreading
• Style guide
  • Footnotes
  • Capitalization
  • Diátaxis
  • Links
  • Affirmative tone
  • Economy of expression
  • Security considerations (and other concerns)
  • Code examples
  • Code equivalents
  • Audience
• reStructuredText markup
  • Quick reference
  • reStructuredText primer
    • Use of whitespace
    • Paragraphs
    • Inline markup
    • Lists and quotes
    • Source code
    • Hyperlinks
      • External links
      • Internal links
    • Sections
    • Explicit markup
    • Directives
    • Footnotes
    • Comments
    • Source encoding
    • Gotchas
  • Typographic conventions
    • Big O notation
  • Additional markup constructs
    • Meta-information markup
    • Module-specific markup
    • Information units
    • Showing code examples
    • Roles
    • Cross-linking markup
    • Paragraph-level markup
    • Table-of-contents markup
    • Index-generating markup
    • Grammar production displays
    • Substitutions
• Translating
  • Starting a new translation
  • PEP 545 summary
  • How to get help
  • Translation FAQ
    • Which version of the Python documentation should be translated?
    • Are there some tools to help in managing the repo?
    • How is a coordinator elected?
    • The entry for my translation is missing/not up to date on this page
    • I have a translation, but it’s not in Git. What should I do?
    • My Git hierarchy does not match yours. Can I keep it?
    • What hierarchy should I use in my GitHub repository?
• Helping with the Developer’s Guide
  • Developer’s Guide workflow
• Multicultural Communication Tips
  • Assume Good Faith and Intent
  • Giving and Receiving Feedback Gracefully
  • Using Tools like LLMs for Clarity
  • Model Behavior that Encourages Learning
  • Social Rules for Respectful Communication
  • Acknowledge Mistakes and Move On
  • Focus on Collaboration over Criticism
  • Code of Conduct and Community Guidelines
  • How to Use These Tips