Project Links

Meta

Author: Oleh Prypin

Requires Python: >=3.7

Classifiers

Development Status

5 - Production/Stable

Environment

Console
Web Environment

Intended Audience

Developers

License

OSI Approved :: MIT License

Operating System

OS Independent

Programming Language

Python
Python :: 3.7
Python :: 3.8
Python :: 3.9
Python :: 3.10
Python :: 3.11

Topic

Documentation
Software Development :: Documentation
Text Processing :: Markup :: Markdown

Typing

Typed

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.

Wheel compatibility matrix

Platform	Python 3
any

Files in release

mkdocs_gen_files-0.5.0-py3-none-any.whl (8.2KiB)

mkdocs_gen_files-0.5.0.tar.gz (7.4KiB)

Extras: None

Dependencies:

mkdocs (>=1.0.3)

mkdocs-gen-files 0.5.0