Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time
We want to extend the default template instead of defining everything ourselves.
{% extends "default/module.html.jinja2" %}
We can redefine individual blocks.
For example, if the `--favicon` option does not do what you want, you can specify a replacement like this.
{% block favicon %}
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,{% filter urlencode %}{% include "resources/pdoc-logo.svg" %}{% endfilter %}"/>
{% endblock %}
We can access system environment variables in the template, for example to pass version information.
{% block nav_footer %}
<footer>My Package v{{ env["VERSION"] | default("1.0") }}</footer>
{% endblock %}
We can also adjust which members are documented by overriding the is_public macro.
In this example, the private function `Dog.__lt__` is exposed publicly.
However, doing this is not recommended, see
{% macro is_public(doc) %}
{% if doc.qualname == "Dog.__lt__" %}
{% else %}
{{ default_is_public(doc) }}
{% endif %}
{% endmacro %}