mkdocs-gen-files
Plugin for MkDocs to programmatically generate documentation pages during the build
pip install mkdocs-gen-files
Continue to the documentation site.
Usage
Activate the plugin in mkdocs.yml (scripts is a required list of Python scripts to execute, always relative to mkdocs.yml):
plugins:
- search
- gen-files:
scripts:
- gen_pages.py # or any other name or path
Then create such a script gen_pages.py (this is relative to the root, not to the docs directory).
import mkdocs_gen_files
with mkdocs_gen_files.open("foo.md", "w") as f:
print("Hello, world!", file=f)
This added a programmatically generated page to our site. That is, the document doesn't actually appear in our source files, it only virtually becomes part of the site to be built by MkDocs.
Continue to the documentation site.
1 maintainer
Release files for mkdocs-gen-files 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_gen_files-0.6.1.tar.gz | 8.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_gen_files-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.0 kB
Release files / mkdocs_gen_files-0.6.1.tar.gz
| Download URL | mkdocs_gen_files-0.6.1.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57d7ff2229e23d077e46d14a33db6d37c8823f6ce1a503c874c1764a71679763
|
|
BLAKE2b-256 checksum How to use checksums |
4343428f312149c161cae557eecd35f3c4a82b867998b1d47fb29fdfe927be26
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 16, 2026.
Transparency logRelease files / mkdocs_gen_files-0.6.1-py3-none-any.whl
| Download URL | mkdocs_gen_files-0.6.1-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b3182bfc6219e35b8d26658cb988368659d5d023aac30c2a819247558fc12189
|
|
BLAKE2b-256 checksum How to use checksums |
ee1b3075eb67fe66e19db059f0a25744c4e56978a309603a20e1d3353d545b5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 16, 2026.
Transparency log
