MkDocs plugin to programmatically generate documentation pages during the build
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mkdocs_gen_files-0.5.0.tar.gz.
File metadata
- Download URL: mkdocs_gen_files-0.5.0.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.23.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4c7cf256b5d67062a788f6b1d035e157fc1a9498c2399be9af5257d4ff4d19bc |
|
| MD5 | cf3a80faf4598095178dbff58d77d57b |
|
| BLAKE2b-256 | 48852d634462fd59136197d3126ca431ffb666f412e3db38fd5ce3a60566303e |
Provenance
File details
Details for the file mkdocs_gen_files-0.5.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_gen_files-0.5.0-py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.23.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7ac060096f3f40bd19039e7277dd3050be9a453c8ac578645844d4d91d7978ea |
|
| MD5 | 003a829cd28ba3b01b81776e2aec45d8 |
|
| BLAKE2b-256 | e70f1e55b3fd490ad2cecb6e7b31892d27cb9fc4218ec1dab780440ba8579e74 |
