Description:

mkdocsgenfiles 0.5.0

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.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter