Edit on GitHub

pdoc

What is pdoc?

pdoc auto-generates API documentation that follows your project's Python module hierarchy.

pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well.

  • Easy setup, no configuration necessary.
  • Documentation is plain Markdown.
  • First-class support for type annotations.
  • Builtin web server with live reloading.
  • Customizable HTML templates.
  • Understands numpydoc and Google-style docstrings.

Quickstart

As an example, we want to generate API documentation for demo.py. Our demo module already includes a bunch of docstrings:

"""
A small `pdoc` example.
"""

class Dog:
    """🐕"""
    name: str
    """The name of our dog."""
    friends: list["Dog"]
    """The friends of our dog."""

    def __init__(self, name: str):
        """Make a Dog without any friends (yet)."""
        self.name = name
        self.friends = []

    def bark(self, loud: bool = True):
        """*woof*"""

We can invoke pdoc to take our docstrings and render them into a standalone HTML document:

pdoc ./demo.py  # or: pdoc my_module_name

This opens a browser with our module documentation. Here's a copy of what you should see:

If you look closely, you'll notice that docstrings are interpreted as Markdown. For example, `pdoc` is rendered as pdoc. Additionally, identifiers such as the type annotation for Dog.friends are automatically linked.

If we edit demo.py now, the page will reload automatically. Once we are happy with everything, we can export the documentation to an HTML file:

pdoc ./demo.py -o ./docs

This will create an HTML file at docs/demo.html which contains our module documentation. 🎉

Customizing pdoc

We can optionally configure pdoc's output via command line flags. For example, we can add a project logo to the documentation:

pdoc ./demo.py --logo "https://placedog.net/300?random"

To get a list of all available rendering options, run:

pdoc --help

If you need more advanced customization options, see How can I edit pdoc's HTML template?.

Deploying to GitHub Pages

In this example we'll deploy pdoc's documentation to GitHub Pages. Of course, you can distribute the generated documentation however you want! pdoc's job is to "just" produce self-contained HTML files for you.

A very simple way to host your API documentation is to set up a continuous integration job which pushes your documentation to GitHub Pages. This keeps your docs updated automatically.

  1. Enable GitHub Actions and GitHub Pages for your project.
  2. In the GitHub Pages settings, select GitHub Actions as your build and deployment source.
  3. Copy pdoc's GitHub Actions workflow into your own repository and adjust it to how you build your docs: .github/workflows/docs.yml

That's it – no need to fiddle with any secrets or set up any gh-pages branches. 🥳

How can I ... ?

...add documentation?

In Python, objects like modules, functions and classes have a special attribute named __doc__ which contains that object's docstring. The docstring comes from a special placement of a string in your source code. For example, the following code shows how to define a function with a docstring and access the contents of that docstring:

>>> def test():
...     """This is a docstring."""
...     pass
...
>>> test.__doc__
'This is a docstring.'

Something similar can be done for classes and modules too. For classes, the docstring should come on the line immediately following class .... For modules, the docstring should start on the first line of the file. These docstrings are what you see for each module, class, function and method listed in the documentation produced by pdoc.

...document variables?

Python itself does not attach docstrings to variables. For example:

variable = "SomeValue"
"""Docstring for variable."""

The resulting variable will have no __doc__ attribute. To compensate, pdoc will read the abstract syntax tree (an abstract representation of the source code) and include all assignment statements immediately followed by a docstring. This approach is not formally standardized, but followed by many tools, including Sphinx's autodoc extension in case you ever decide to migrate off pdoc. Docstring detection is limited to the current module, docstrings for variables imported from other modules are not picked up.

Something similar is done for instance variables, which are either type-annotated in the class or defined in a class's __init__. Here is an example showing both conventions detected by pdoc:

class GoldenRetriever(Dog):
    name: str
    """Full Name"""

    def __init__(self):
        self.weight: int = 10
        """Weight in kilograms"""

If you would like to distinguish an instance variable from a class variable, you can use typing.ClassVar:

class GoldenRetriever(Dog):
    breed_code: ClassVar[str] = "GOLD"
    """International breed code (same for all instances)"""
    name: str
    """Full Name (different for each instance)"""

...control what is documented?

The public interface of a module is determined through one of two ways.

  • If __all__ is defined in the module, then all identifiers in that list will be considered public. No other identifiers will be considered public.
  • If __all__ is not defined, then pdoc will consider all items public that do not start with an underscore and that are defined in the current module (i.e. they are not imported).

If you want to override the default behavior for a particular item, you can do so by including an annotation in its docstring:

  • @private hides an item unconditionally.
  • @public shows an item unconditionally.

In general, we recommend keeping the following conventions:

  • If you want to document a private member, consider making it public.
  • If you want to hide a public member, consider making it private.
  • If you want to document a special __dunder__ method, the recommended way to do so is to not document the dunder method specifically, but to add some usage examples in the class documentation.

As a last resort, you can override pdoc's behavior with a custom module template (see How can I edit pdoc's HTML template?). You can find an example at examples/custom-template/module.html.jinja2.

...exclude submodules from being documented?

If you would like to exclude specific submodules from the documentation, the recommended way is to specify __all__ as shown in the previous section. Alternatively, you can pass negative regular expression !patterns as part of the module specification. Each pattern removes all previously specified (sub)module names that match. For example, the following invocation documents foo and all submodules of foo, but not foo.bar:

pdoc foo !foo.bar

Likewise, pdoc pdoc !pdoc. would document the pdoc module itself, but none of its submodules. Patterns are always matched on the final module name, even if modules are passed as file paths.

In your documentation, you can link to other identifiers by enclosing them in backticks: `pdoc` will link to pdoc. When linking to identifiers in other modules, the identifier name must be fully qualified. For example, `pdoc.doc.Doc` will be automatically linked to pdoc.doc.Doc, while `Doc` only works within the pdoc.doc module.

pdoc will link all identifiers that are rendered in the current run. This means that you need to run pdoc module_a module_b to have interlinking between module_a and module_b. If you run pdoc module_a followed by pdoc module_b, there will be no cross-linking between the two modules.

...change the item order?

By default, documentation items are sorted in order of (first) appearance in the source code. This means that if you want to move a particular function to the beginning of your documentation, you need to move it there in your source code. This is not only useful to the readers of your documentation, but also useful to the consumers of your source code.

...use numpydoc or Google docstrings?

While pdoc prefers docstrings that are plain Markdown, it also understands numpydoc and Google-style docstrings. If your documentation follows one of these styles, you can:

  1. Run pdoc --docformat ... to enable a particular docstring flavor globally, or
  2. Add __docformat__ = "..." at the top-level of the module you are documenting.

The following values are supported:

  • markdown: Process Markdown syntax only.
  • restructuredtext: Process reStructuredText elements, then Markdown (default setting).
  • google: Process reStructuredText elements, then Google-style syntax, then Markdown.
  • numpy: Process reStructuredText elements, then Numpydoc syntax, then Markdown.

pdoc only interprets a subset of the reStructuredText specification. Adding additional syntax elements is usually easy. If you feel that pdoc doesn't parse a docstring element properly, please amend pdoc.docstrings and send us a pull request!

...render math formulas?

Run pdoc --math, and pdoc will render formulas in your docstrings. See math_demo for details.

...render Mermaid diagrams?

Run pdoc --mermaid, and pdoc will render mermaid diagrams in your docstrings. See mermaid_demo for details.

See Customizing pdoc.

...include Markdown files?

You can include external Markdown files in your documentation by using reStructuredText's .. include:: directive. For example, a common pattern is to include your project's README in your top-level __init__.py like this:

"""
.. include:: ../README.md
"""

You can also include only parts of a file with the start-line, end-line, start-after, and end-after options:

"""
.. include:: ../README.md
   :start-line: 1
   :end-before: Changelog
"""

...add a title page?

The landing page for your documentation is your project's top-level <modulename>/__init__.py file. Adding a module-level docstring here is a great way to introduce users to your project. For example, the documentation you are reading right now is sourced from pdoc/__init__.py. You can also include your title page from a Markdown file.

If you have multiple top-level modules, a custom title page requires modifying the index.html.jinja2 template. You can find an example in #410.

...edit pdoc's HTML template?

For more advanced customization, we can edit pdoc's default HTML template, which uses the Jinja2 templating language.

Let's assume you want to replace the logo with a custom button. We first find the right location in the template by searching for "logo", which shows us that the logo is defined in a Jinja2 block named nav_title. We now extend the default template by creating a file titled module.html.jinja2 in the current directory with the following contents:

{% extends "default/module.html.jinja2" %}
{% block nav_title %}
<button>Donate dog food</button>
{% endblock %}

We then specify our custom template directory when invoking pdoc...

pdoc -t . ./demo.py

...and the updated documentation – with button – renders! 🎉

See examples/ for more examples.

...pass arguments to the Jinja2 template?

If you need to pass additional data to pdoc's Jinja2 templates, you can use system environment variables. For example, examples/custom-template/module.html.jinja2 shows how to include a version number in the rendered HTML.

...integrate pdoc into other systems?

pdoc's HTML and CSS are written in a way that the default template can be easily adjusted to produce standalone HTML fragments that can be embedded in other systems. This makes it possible to integrate pdoc with almost every CMS or static site generator. The only limitation is that you need to retain pdoc's directory structure if you would like to link between modules.

To do so, create a custom frame.html.jinja2 template which only emits CSS and the main page contents instead of a full standalone HTML document:

{% block content %}{% endblock %}

{% filter minify_css %}
    {% block style %}
        {# The same CSS files as in pdoc's default template, except for layout.css.
        You may leave out Bootstrap Reboot, which corrects inconsistences across browsers
        but may conflict with you website's stylesheet. #}
        <style>{% include "resources/bootstrap-reboot.min.css" %}</style>
        <style>{% include "syntax-highlighting.css" %}</style>
        <style>{% include "theme.css" %}</style>
        <style>{% include "content.css" %}</style>
    {% endblock %}
{% endfilter %}

This should be enough to produce HTML files that can be embedded into other pages. All CSS selectors are prefixed with pdoc so that pdoc's page style does not interfere with the rest of your website.

You can find a full example for mkdocs in examples/mkdocs.

Docstring Inheritance

pdoc extends the standard use of docstrings in two important ways: by introducing variable docstrings (see How can I document variables?), and by allowing functions and classes to inherit docstrings and type annotations.

This is useful to not unnecessarily repeat information. Consider this example:

class Dog:
    def bark(self, loud: bool) -> None:
        """
        Make the dog bark. If `loud` is True,
        use full volume. Not supported by all breeds.
        """

class GoldenRetriever(Dog):
    def bark(self, loud: bool) -> None:
        print("Woof Woof")

In Python, the docstring for GoldenRetriever.bark is empty, even though one was defined in Dog.bark. If pdoc generates documentation for the above code, then it will automatically attach the docstring for Dog.bark to GoldenRetriever.bark if it does not have a docstring.

Limitations

  • Scope: pdoc main use case is API documentation. If you have substantially more complex documentation needs, we recommend using Sphinx!
  • Dynamic analysis: pdoc makes heavy use of dynamic analysis to extract docstrings. This means your Python modules will be executed/imported when pdoc runs.
  • HTML Output: pdoc only supports HTML as an output format. If you want to use pdoc with a static site generator that only accepts Markdown, that may work nonetheless – take a look at integrating pdoc into other systems.

Markdown Support

Markdown is a lightweight and popular markup language for text formatting. There are many versions or "flavors" of Markdown. pdoc uses the markdown2 library, which closely matches the behavior of the original Markdown 1.0.1 spec. In addition, the following extra syntax elements are enabled:

  • code-friendly: Disable _ and __ for em and strong.
  • cuddled-lists: Allow lists to be cuddled to the preceding paragraph.
  • fenced-code-blocks: Allows a code block to not have to be indented by fencing it with ``` on a line before and after. Based on GitHub-Flavored Markdown with support for syntax highlighting.
  • footnotes: Support footnotes as in use on daringfireball.net and implemented in other Markdown processors.
  • header-ids: Adds "id" attributes to headers. The id value is a slug of the header text.
  • markdown-in-html: Allow the use of markdown="1" in a block HTML tag to have markdown processing be done on its contents. Similar to PHP-Markdown Extra but with some limitations.
  • mermaid: Allows rendering Mermaid diagrams from included Markdown files using ```mermaid fence blocks.
  • pyshell: Treats unindented Python interactive shell sessions as <code> blocks.
  • strike: Parse ~~strikethrough~~ formatting.
  • tables: Tables using the same format as GitHub-Flavored Markdown and PHP-Markdown Extra.
  • task_list: Allows GitHub-style task lists (i.e. check boxes)
  • toc: The returned HTML string gets a new "toc_html" attribute which is a Table of Contents for the document.

It is possible (but not recommended) to use another Markdown library with pdoc. See #401 for details.

Using pdoc as a library

pdoc provides the high-level pdoc() interface explained below. This makes it possible to do custom adjustments to your Python code before pdoc is used.

It is also possible to create pdoc.doc.Module objects directly and modify them before rendering. You can find an example in examples/library-usage.

  1r'''
  2# What is pdoc?
  3
  4pdoc auto-generates API documentation that follows your project's Python module hierarchy.
  5
  6pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well.
  7
  8 - Easy setup, no configuration necessary.
  9 - Documentation is plain [Markdown](#markdown-support).
 10 - First-class support for type annotations.
 11 - Builtin web server with live reloading.
 12 - Customizable HTML templates.
 13 - Understands numpydoc and Google-style docstrings.
 14
 15# Quickstart
 16
 17As an example, we want to generate API documentation for `demo.py`.
 18Our demo module already includes a bunch of docstrings:
 19
 20```python
 21"""
 22A small `pdoc` example.
 23"""
 24
 25class Dog:
 26    """🐕"""
 27    name: str
 28    """The name of our dog."""
 29    friends: list["Dog"]
 30    """The friends of our dog."""
 31
 32    def __init__(self, name: str):
 33        """Make a Dog without any friends (yet)."""
 34        self.name = name
 35        self.friends = []
 36
 37    def bark(self, loud: bool = True):
 38        """*woof*"""
 39```
 40
 41We can invoke pdoc to take our docstrings and render them into a standalone HTML document:
 42
 43```shell
 44pdoc ./demo.py  # or: pdoc my_module_name
 45```
 46
 47This opens a browser with our module documentation. Here's a copy of what you should see:
 48
 49<iframe style="
 50    width: 100%;
 51    height: 250px;
 52    border: solid gray 1px;
 53    display: block;
 54    margin: 1rem auto;
 55    border-radius: 5px;"
 56    title="rendered demo.py documentation"
 57    src="https://pdoc.dev/docs/demo-standalone.html"></iframe>
 58
 59If you look closely, you'll notice that docstrings are interpreted as Markdown.
 60For example, \`pdoc\` is rendered as `pdoc`. Additionally, identifiers such as the type annotation
 61for `Dog.friends` are automatically linked.
 62
 63If we edit `demo.py` now, the page will reload automatically.
 64Once we are happy with everything, we can export the documentation to an HTML file:
 65
 66```shell
 67pdoc ./demo.py -o ./docs
 68```
 69
 70This will create an HTML file at `docs/demo.html` which contains our module documentation. 🎉
 71
 72## Customizing pdoc
 73
 74We can optionally configure pdoc's output via command line flags.
 75For example, we can add a project logo to the documentation:
 76
 77```shell
 78pdoc ./demo.py --logo "https://placedog.net/300?random"
 79```
 80
 81To get a list of all available rendering options, run:
 82
 83```shell
 84pdoc --help
 85```
 86
 87If you need more advanced customization options, see [*How can I edit pdoc's HTML template?*](#edit-pdocs-html-template).
 88
 89
 90## Deploying to GitHub Pages
 91
 92*In this example we'll deploy pdoc's documentation to GitHub Pages. Of course, you can distribute
 93the generated documentation however you want! pdoc's job is to "just" produce self-contained HTML files for you.*
 94
 95A very simple way to host your API documentation is to set up a continuous integration job which
 96pushes your documentation to GitHub Pages. This keeps your docs updated automatically.
 97
 98 1. Enable GitHub Actions and GitHub Pages for your project.
 99 2. In the GitHub Pages settings, select GitHub Actions as your build and deployment source.
100 3. Copy pdoc's GitHub Actions workflow into your own repository and adjust it to how you build your docs:
101    [`.github/workflows/docs.yml`](https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml)
102
103That's it – no need to fiddle with any secrets or set up any `gh-pages` branches. 🥳
104
105# How can I ... ?
106
107## ...add documentation?
108
109In Python, objects like modules, functions and classes have
110a special attribute named `__doc__` which contains that object's
111*docstring*.  The docstring comes from a special placement of a string
112in your source code.  For example, the following code shows how to
113define a function with a docstring and access the contents of that
114docstring:
115
116```python
117>>> def test():
118...     """This is a docstring."""
119...     pass
120...
121>>> test.__doc__
122'This is a docstring.'
123```
124
125Something similar can be done for classes and modules too. For classes,
126the docstring should come on the line immediately following `class
127...`. For modules, the docstring should start on the first line of
128the file. These docstrings are what you see for each module, class,
129function and method listed in the documentation produced by pdoc.
130
131
132## ...document variables?
133
134Python itself [does not attach docstrings to
135variables](https://www.python.org/dev/peps/pep-0224/). For example:
136
137```python
138variable = "SomeValue"
139"""Docstring for variable."""
140```
141
142The resulting `variable` will have no `__doc__` attribute.
143To compensate, pdoc will read the abstract syntax tree (an abstract representation of the source code)
144and include all assignment statements immediately followed by a docstring. This approach is not formally standardized,
145but followed by many tools, including Sphinx's autodoc extension in case you ever decide to migrate off pdoc.
146Docstring detection is limited to the current module, docstrings for variables imported from other modules are not
147picked up.
148
149Something similar is done for instance variables, which are either type-annotated in the class
150or defined in a class's `__init__`. Here is an example showing both conventions detected by pdoc:
151
152```python
153class GoldenRetriever(Dog):
154    name: str
155    """Full Name"""
156
157    def __init__(self):
158        self.weight: int = 10
159        """Weight in kilograms"""
160```
161
162
163If you would like to distinguish an instance variable from a class variable,
164you can use [`typing.ClassVar`](https://docs.python.org/3/library/typing.html#typing.ClassVar):
165
166```python
167class GoldenRetriever(Dog):
168    breed_code: ClassVar[str] = "GOLD"
169    """International breed code (same for all instances)"""
170    name: str
171    """Full Name (different for each instance)"""
172```
173
174
175## ...control what is documented?
176
177The public interface of a module is determined through one of two
178ways.
179- If `__all__` is defined in the module, then all identifiers in that list will be considered public.
180   No other identifiers will be considered public.
181- If `__all__` is not defined, then pdoc will consider all items public that do not start with an
182  underscore and that are defined in the current module (i.e. they are not imported).
183
184If you want to override the default behavior for a particular item,
185you can do so by including an annotation in its docstring:
186
187- `@private` hides an item unconditionally.
188- <code>&#64;public</code> shows an item unconditionally.
189
190In general, we recommend keeping the following conventions:
191
192- If you want to document a private member, consider making it public.
193- If you want to hide a public member, consider making it private.
194- If you want to document a special `__dunder__` method, the recommended way to do so is
195  to not document the dunder method specifically, but to add some usage examples in the class documentation.
196
197As a last resort, you can override pdoc's behavior with a custom module template (see
198[*How can I edit pdoc's HTML template?*](#edit-pdocs-html-template)).
199You can find an example at
200[`examples/custom-template/module.html.jinja2`](https://github.com/mitmproxy/pdoc/blob/main/examples/custom-template/module.html.jinja2).
201
202## ...exclude submodules from being documented?
203
204If you would like to exclude specific submodules from the documentation, the recommended way is to specify `__all__` as
205shown in the previous section. Alternatively, you can pass negative regular expression `!patterns` as part of the
206module specification. Each pattern removes all previously specified (sub)module names that match. For example, the following
207invocation documents `foo` and all submodules of `foo`, but not `foo.bar`:
208
209```
210pdoc foo !foo.bar
211```
212
213Likewise, `pdoc pdoc !pdoc.` would document the pdoc module itself, but none of its submodules. Patterns are always
214matched on the final module name, even if modules are passed as file paths.
215
216
217## ...link to other identifiers?
218
219In your documentation, you can link to other identifiers by enclosing them in backticks:
220<code>\`pdoc\`</code> will link to `pdoc`.
221When linking to identifiers in other modules, the identifier name must be fully qualified.
222For example, <code>\`pdoc.doc.Doc\`</code> will be automatically linked to `pdoc.doc.Doc`,
223while <code>\`Doc\`</code> only works within the `pdoc.doc` module.
224
225pdoc will link all identifiers that are rendered in the current run.
226This means that you need to run `pdoc module_a module_b` to have interlinking between module_a and module_b.
227If you run `pdoc module_a` followed by `pdoc module_b`, there will be no cross-linking between the two modules.
228
229
230## ...change the item order?
231
232By default, documentation items are sorted in order of (first) appearance in the source code.
233This means that if you want to move a particular function to the beginning of your documentation,
234you need to move it there in your source code. This is not only useful to the readers of your documentation,
235but also useful to the consumers of your source code.
236
237
238## ...use numpydoc or Google docstrings?
239
240While pdoc prefers docstrings that are plain Markdown, it also understands numpydoc and Google-style docstrings.
241If your documentation follows one of these styles, you can:
242
2431. Run `pdoc --docformat ...` to enable a particular docstring flavor globally, or
2442. Add `__docformat__ = "..."` at the top-level of the module you are documenting.
245
246The following values are supported:
247
248- `markdown`: Process Markdown syntax only.
249- `restructuredtext`: Process reStructuredText elements, then Markdown (default setting).
250- `google`: Process reStructuredText elements, then Google-style syntax, then Markdown.
251- `numpy`: Process reStructuredText elements, then Numpydoc syntax, then Markdown.
252
253pdoc only interprets a subset of the reStructuredText specification.
254Adding additional syntax elements is usually easy. If you feel that pdoc doesn't parse a docstring element properly,
255please amend `pdoc.docstrings` and send us a pull request!
256
257
258## ...render math formulas?
259
260Run `pdoc --math`, and pdoc will render formulas in your docstrings. See
261[`math_demo`](https://pdoc.dev/docs/math/math_demo.html) for details.
262
263
264## ...render Mermaid diagrams?
265
266Run `pdoc --mermaid`, and pdoc will render mermaid diagrams in your docstrings. See
267[`mermaid_demo`](https://pdoc.dev/docs/mermaid/mermaid_demo.html) for details.
268
269
270## ...add my project's logo?
271
272See [*Customizing pdoc*](#customizing-pdoc).
273
274
275## ...include Markdown files?
276
277You can include external Markdown files in your documentation by using reStructuredText's
278`.. include::` directive. For example, a common pattern is to include your project's README in your top-level `__init__.py` like this:
279
280```python
281"""
282.. include:: ../README.md
283"""
284```
285
286You can also include only parts of a file with the
287[`start-line`, `end-line`, `start-after`, and `end-after` options](https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment):
288
289```python
290"""
291.. include:: ../README.md
292   :start-line: 1
293   :end-before: Changelog
294"""
295```
296
297
298## ...add a title page?
299
300The landing page for your documentation is your project's top-level `<modulename>/__init__.py` file.
301Adding a module-level docstring here is a great way to introduce users to your project.
302For example, the documentation you are reading right now is sourced from
303[`pdoc/__init__.py`](https://github.com/mitmproxy/pdoc/blob/main/pdoc/__init__.py).
304You can also include your title page from a [Markdown file](#include-markdown-files).
305
306If you have multiple top-level modules, a custom title page requires modifying the `index.html.jinja2` template.
307You can find an example in [#410](https://github.com/mitmproxy/pdoc/issues/410).
308
309## ...edit pdoc's HTML template?
310
311For more advanced customization, we can edit pdoc's
312[default HTML template](https://github.com/mitmproxy/pdoc/blob/main/pdoc/templates/default/module.html.jinja2),
313which uses the
314[Jinja2](https://jinja.palletsprojects.com/) templating language.
315
316Let's assume you want to replace the logo with a custom button. We first find the right location in the template by searching
317for "logo", which shows us that the logo is defined in a Jinja2 block named `nav_title`.
318We now extend the default template by creating a file titled `module.html.jinja2` in the current directory
319 with the following contents:
320
321```html+jinja
322{% extends "default/module.html.jinja2" %}
323{% block nav_title %}
324<button>Donate dog food</button>
325{% endblock %}
326```
327
328We then specify our custom template directory when invoking pdoc...
329
330```shell
331pdoc -t . ./demo.py
332```
333
334...and the updated documentation – with button – renders! 🎉
335
336See [`examples/`](https://github.com/mitmproxy/pdoc/tree/main/examples/)
337for more examples.
338
339
340## ...pass arguments to the Jinja2 template?
341
342If you need to pass additional data to pdoc's Jinja2 templates,
343you can use system environment variables.
344For example,
345[`examples/custom-template/module.html.jinja2`](https://github.com/mitmproxy/pdoc/blob/main/examples/custom-template/module.html.jinja2)
346shows how to include a version number in the rendered HTML.
347
348
349## ...integrate pdoc into other systems?
350
351pdoc's HTML and CSS are written in a way that the default template can be easily adjusted
352to produce standalone HTML fragments that can be embedded in other systems.
353This makes it possible to integrate pdoc with almost every CMS or static site generator.
354The only limitation is that you need to retain pdoc's directory structure
355if you would like to link between modules.
356
357To do so, [create a custom `frame.html.jinja2` template](#edit-pdocs-html-template) which only emits CSS and the main
358page contents instead of a full standalone HTML document:
359```html+jinja
360{% block content %}{% endblock %}
361
362{% filter minify_css %}
363    {% block style %}
364        {# The same CSS files as in pdoc's default template, except for layout.css.
365        You may leave out Bootstrap Reboot, which corrects inconsistences across browsers
366        but may conflict with you website's stylesheet. #}
367        <style>{% include "resources/bootstrap-reboot.min.css" %}</style>
368        <style>{% include "syntax-highlighting.css" %}</style>
369        <style>{% include "theme.css" %}</style>
370        <style>{% include "content.css" %}</style>
371    {% endblock %}
372{% endfilter %}
373```
374
375This should be enough to produce HTML files that can be embedded into other pages.
376All CSS selectors are prefixed with `.pdoc` so that pdoc's page style does not interfere with the rest of your website.
377
378You can find a full example for mkdocs in [`examples/mkdocs`](https://github.com/mitmproxy/pdoc/tree/main/examples/mkdocs/).
379
380
381# Docstring Inheritance
382
383pdoc extends the standard use of docstrings in two important ways:
384by introducing variable docstrings (see [*How can I document variables?*](#document-variables)),
385and by allowing functions and classes to inherit docstrings and type annotations.
386
387This is useful to not unnecessarily repeat information. Consider this example:
388
389```python
390class Dog:
391    def bark(self, loud: bool) -> None:
392        """
393        Make the dog bark. If `loud` is True,
394        use full volume. Not supported by all breeds.
395        """
396
397class GoldenRetriever(Dog):
398    def bark(self, loud: bool) -> None:
399        print("Woof Woof")
400```
401
402In Python, the docstring for `GoldenRetriever.bark` is empty, even though one was
403defined in `Dog.bark`. If pdoc generates documentation for the above
404code, then it will automatically attach the docstring for `Dog.bark` to
405`GoldenRetriever.bark` if it does not have a docstring.
406
407
408# Limitations
409
410  - **Scope:** pdoc main use case is API documentation.
411    If you have substantially more complex documentation needs, we recommend using [Sphinx](https://www.sphinx-doc.org/)!
412  - **Dynamic analysis:** pdoc makes heavy use of dynamic analysis to extract docstrings.
413    This means your Python modules will be executed/imported when pdoc runs.
414  - **HTML Output:** pdoc only supports HTML as an output format. If you want to use pdoc with a static site
415    generator that only accepts Markdown, that may work nonetheless – take a look at
416    [integrating pdoc into other systems](https://pdoc.dev/docs/pdoc.html#integrate-pdoc-into-other-systems).
417
418
419# Markdown Support
420
421[Markdown](https://guides.github.com/features/mastering-markdown/) is a lightweight and popular markup language for text
422formatting. There are many versions or *"flavors"* of Markdown.
423pdoc uses the [markdown2](https://github.com/trentm/python-markdown2) library, which closely matches
424the behavior of the original [Markdown 1.0.1 spec][].
425In addition, the following extra syntax elements are enabled:
426
427  - **[code-friendly][]:** Disable `_` and `__` for `em` and `strong`.
428  - **[cuddled-lists][]:** Allow lists to be cuddled to the preceding
429    paragraph.
430  - **[fenced-code-blocks][]:** Allows a code block to not have to be
431    indented by fencing it with <code>```</code> on a line before and after.
432    Based on [GitHub-Flavored Markdown][] with support for syntax highlighting.
433  - **[footnotes][]:** Support footnotes as in use on daringfireball.net
434    and implemented in other Markdown processors.
435  - **[header-ids][]:** Adds "id" attributes to headers. The id value
436    is a slug of the header text.
437  - **[markdown-in-html][]:** Allow the use of `markdown="1"` in a
438    block HTML tag to have markdown processing be done on its contents.
439    Similar to [PHP-Markdown Extra][] but with some limitations.
440  - **[mermaid][]:** Allows rendering Mermaid diagrams from included Markdown files using <code>```mermaid</code> fence blocks.
441  - **[pyshell][]:** Treats unindented Python interactive shell
442    sessions as `<code>` blocks.
443  - **strike:** Parse `~~strikethrough~~` formatting.
444  - **[tables][]:** Tables using the same format as [GitHub-Flavored Markdown][] and
445    [PHP-Markdown Extra][].
446  - **task_list:** Allows GitHub-style task lists (i.e. check boxes)
447  - **toc:** The returned HTML string gets a new "toc_html"
448    attribute which is a Table of Contents for the document.
449
450[Markdown 1.0.1 spec]: https://daringfireball.net/projects/markdown/
451[code-friendly]: https://github.com/trentm/python-markdown2/wiki/code-friendly
452[cuddled-lists]: https://github.com/trentm/python-markdown2/wiki/cuddled-lists
453[fenced-code-blocks]: https://github.com/trentm/python-markdown2/wiki/fenced-code-blocks
454[footnotes]: https://github.com/trentm/python-markdown2/wiki/footnotes
455[header-ids]: https://github.com/trentm/python-markdown2/wiki/header-ids
456[markdown-in-html]: https://github.com/trentm/python-markdown2/wiki/markdown-in-html
457[mermaid]: https://github.com/trentm/python-markdown2/wiki/mermaid
458[pyshell]: https://github.com/trentm/python-markdown2/wiki/pyshell
459[tables]: https://github.com/trentm/python-markdown2/wiki/tables
460[GitHub-Flavored Markdown]: https://github.github.com/gfm/
461[PHP-Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/#table
462
463It is possible (but not recommended) to use another Markdown library with pdoc.
464See [#401](https://github.com/mitmproxy/pdoc/issues/401#issuecomment-1148661829) for details.
465
466# Using pdoc as a library
467
468pdoc provides the high-level `pdoc.pdoc()` interface explained below. This makes it possible to do custom adjustments
469to your Python code before pdoc is used.
470
471It is also possible to create `pdoc.doc.Module` objects directly and modify them before rendering.
472You can find an example in [`examples/library-usage`](https://github.com/mitmproxy/pdoc/tree/main/examples/library-usage).
473'''
474
475from __future__ import annotations
476
477__docformat__ = "markdown"  # explicitly disable rST processing in the examples above.
478__version__ = "14.5.0"  # this is read from setup.py
479
480from pathlib import Path
481from typing import overload
482
483from pdoc import doc
484from pdoc import extract
485from pdoc import render
486
487
488@overload
489def pdoc(
490    *modules: Path | str,
491    output_directory: None = None,
492) -> str:
493    pass
494
495
496@overload
497def pdoc(
498    *modules: Path | str,
499    output_directory: Path,
500) -> None:
501    pass
502
503
504def pdoc(
505    *modules: Path | str,
506    output_directory: Path | None = None,
507) -> str | None:
508    """
509    Render the documentation for a list of modules.
510
511     - If `output_directory` is `None`, returns the rendered documentation
512       for the first module in the list.
513     - If `output_directory` is set, recursively writes the rendered output
514       for all specified modules and their submodules to the target destination.
515
516    Rendering options can be configured by calling `pdoc.render.configure` in advance.
517    """
518    all_modules: dict[str, doc.Module] = {}
519    for module_name in extract.walk_specs(modules):
520        all_modules[module_name] = doc.Module.from_name(module_name)
521
522    for module in all_modules.values():
523        out = render.html_module(module, all_modules)
524        if not output_directory:
525            return out
526        else:
527            outfile = output_directory / f"{module.fullname.replace('.', '/')}.html"
528            outfile.parent.mkdir(parents=True, exist_ok=True)
529            outfile.write_bytes(out.encode())
530
531    assert output_directory
532
533    index = render.html_index(all_modules)
534    if index:
535        (output_directory / "index.html").write_bytes(index.encode())
536
537    search = render.search_index(all_modules)
538    if search:
539        (output_directory / "search.js").write_bytes(search.encode())
540
541    return None
def pdoc( *modules: pathlib.Path | str, output_directory: pathlib.Path | None = None) -> str | None: 
505def pdoc(
506    *modules: Path | str,
507    output_directory: Path | None = None,
508) -> str | None:
509    """
510    Render the documentation for a list of modules.
511
512     - If `output_directory` is `None`, returns the rendered documentation
513       for the first module in the list.
514     - If `output_directory` is set, recursively writes the rendered output
515       for all specified modules and their submodules to the target destination.
516
517    Rendering options can be configured by calling `pdoc.render.configure` in advance.
518    """
519    all_modules: dict[str, doc.Module] = {}
520    for module_name in extract.walk_specs(modules):
521        all_modules[module_name] = doc.Module.from_name(module_name)
522
523    for module in all_modules.values():
524        out = render.html_module(module, all_modules)
525        if not output_directory:
526            return out
527        else:
528            outfile = output_directory / f"{module.fullname.replace('.', '/')}.html"
529            outfile.parent.mkdir(parents=True, exist_ok=True)
530            outfile.write_bytes(out.encode())
531
532    assert output_directory
533
534    index = render.html_index(all_modules)
535    if index:
536        (output_directory / "index.html").write_bytes(index.encode())
537
538    search = render.search_index(all_modules)
539    if search:
540        (output_directory / "search.js").write_bytes(search.encode())
541
542    return None

Render the documentation for a list of modules.

  • If output_directory is None, returns the rendered documentation for the first module in the list.
  • If output_directory is set, recursively writes the rendered output for all specified modules and their submodules to the target destination.

Rendering options can be configured by calling pdoc.render.configure in advance.