Introduction

Welcome to pydoctor’s documentation!

Contents:

• Quick Start
  • Installation
  • Example
  • Publish your documentation
  • Return codes
• How to Document Your Code
  • Docstrings
  • Docstring assignments
  • Constants
  • Fields
    • Type fields
  • Type annotations
  • Properties
  • Using attrs
  • Private API
  • Re-exporting
  • Branch priorities
• Documentation Formats
  • Epytext
    • Epytext demo package
    • Fields
  • reStructuredText
    • reStructuredText demo package
    • Fields
    • Cross-references
    • Directives
      • Colorized snippets directive
  • Google and Numpy
    • Google-style demo package
    • Numpy-style demo package
    • Sections
• Sphinx Integration
  • Linking from pydoctor to external API docs
  • Linking from Sphinx to your pydoctor API docs
  • Building pydoctor together with Sphinx HTML build
• Theming and other customizations
  • Configure sidebar expanding/collapsing
  • Theming
  • Tweak HTML templates
  • Override objects privacy (show/hide)
    • Privacy tweak examples
  • Use a custom system class
    • Brief on pydoctor extensions
    • A concrete example
  • Use a custom writer class
• CLI Options and Config File
  • Command line options
    • Positional Arguments
    • Named Arguments
  • Configuration file
    • pydoctor.ini
    • pyproject.toml
    • setup.cfg
• Frequently Asked Questions
  • Why?
  • Who wrote pydoctor?
  • Why would I use it?
  • How is it different from sphinx-autodoc
  • What does the output look like?
  • Who is using pydoctor?
  • How do I use it?
• Transition to pydoctor
  • From epydoc
  • From pdoc3
• Contribute
  • What can you do
  • Development process
  • Pre-commit checks
  • Other things hapenning when a PR is open
  • Review process and requirements
  • Releasing and publishing a new package
  • Updating pydoctor for Linux distributions
    • pydoctor and new depending packages
  • Profiling pydoctor with austin and speedscope
    • Note on sampling interval
  • Author Design Notes
• Readme
  • pydoctor
    • Simple Usage
    • Markup
    • What’s New?
      • in development
      • pydoctor 24.11.1
      • pydoctor 24.11.0
      • pydoctor 24.3.3
      • pydoctor 24.3.0
      • pydoctor 23.9.1
      • pydoctor 23.9.0
      • pydoctor 23.4.1
      • pydoctor 23.4.0
      • pydoctor 22.9.1
      • pydoctor 22.9.0
      • pydoctor 22.7.0
      • pydoctor 22.5.1
      • pydoctor 22.5.0
      • pydoctor 22.4.0
      • pydoctor 22.3.0
      • pydoctor 22.2.2
      • pydoctor 22.2.1
      • pydoctor 22.2.0
      • pydoctor 21.12.1
      • pydoctor 21.12.0
      • pydoctor 21.9.2
      • pydoctor 21.9.1
      • pydoctor 21.9.0
      • pydoctor 21.2.2
      • pydoctor 21.2.1
      • pydoctor 21.2.0
      • pydoctor 20.12.1
      • pydoctor 20.12.0
      • pydoctor 20.7.2
      • pydoctor 20.7.1
      • pydoctor 20.7.0

Quick links

• API Reference
• GitHub
• PyPI