mkdocs¶

footman._stubs.mkdocs.Mkdocs ¶

Bases: Tool

build ¶

build(
    *,
    clean: _Flag = ...,
    config_file: _Value = ...,
    quiet: _Flag = ...,
    site_dir: _Value = ...,
    strict: _Flag = ...,
    theme: Literal["mkdocs", "readthedocs"]
    | Sequence[Literal["mkdocs", "readthedocs"]]
    | None = ...,
    use_directory_urls: _Flag = ...,
    verbose: _Flag = ...,
    **flags: Any,
) -> Result

Build the MkDocs documentation.

Parameters:

Name	Type	Description	Default
`clean`	`_Flag`	Remove old files from the site_dir before building (the default). Defaults on — `clean=off` emits `--dirty`.	`...`
`config_file`	`_Value`	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	`...`
`quiet`	`_Flag`	Silence warnings.	`...`
`site_dir`	`_Value`	The directory to output the result of the documentation build.	`...`
`strict`	`_Flag`	Enable strict mode. This will cause MkDocs to abort the build on any warnings. `strict=off` emits `--no-strict`.	`...`
`theme`	`Literal['mkdocs', 'readthedocs'] \| Sequence[Literal['mkdocs', 'readthedocs']] \| None`	The theme to use when building your documentation.	`...`
`use_directory_urls`	`_Flag`	Use directory URLs when building pages (the default). `use_directory_urls=off` emits `--no-directory-urls`.	`...`
`verbose`	`_Flag`	Enable verbose output.	`...`

flags ¶

flags(**flags: Any) -> Mkdocs

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

gh_deploy ¶

gh_deploy(
    *,
    clean: _Flag = ...,
    config_file: _Value = ...,
    force: _Flag = ...,
    ignore_version: _Flag = ...,
    message: _Value = ...,
    no_history: _Flag = ...,
    quiet: _Flag = ...,
    remote_branch: _Value = ...,
    remote_name: _Value = ...,
    shell: _Flag = ...,
    site_dir: _Value = ...,
    strict: _Flag = ...,
    theme: Literal["mkdocs", "readthedocs"]
    | Sequence[Literal["mkdocs", "readthedocs"]]
    | None = ...,
    use_directory_urls: _Flag = ...,
    verbose: _Flag = ...,
    **flags: Any,
) -> Result

Deploy your documentation to GitHub Pages.

Parameters:

Name	Type	Description	Default
`clean`	`_Flag`	Remove old files from the site_dir before building (the default). Defaults on — `clean=off` emits `--dirty`.	`...`
`config_file`	`_Value`	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	`...`
`force`	`_Flag`	Force the push to the repository.	`...`
`ignore_version`	`_Flag`	Ignore check that build is not being deployed with an older version of MkDocs.	`...`
`message`	`_Value`	A commit message to use when committing to the GitHub Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions.	`...`
`no_history`	`_Flag`	Replace the whole Git history with one new commit.	`...`
`quiet`	`_Flag`	Silence warnings.	`...`
`remote_branch`	`_Value`	The remote branch to commit to for GitHub Pages. This overrides the value specified in config.	`...`
`remote_name`	`_Value`	The remote name to commit to for GitHub Pages. This overrides the value specified in config.	`...`
`shell`	`_Flag`	Use the shell when invoking Git.	`...`
`site_dir`	`_Value`	The directory to output the result of the documentation build.	`...`
`strict`	`_Flag`	Enable strict mode. This will cause MkDocs to abort the build on any warnings. `strict=off` emits `--no-strict`.	`...`
`theme`	`Literal['mkdocs', 'readthedocs'] \| Sequence[Literal['mkdocs', 'readthedocs']] \| None`	The theme to use when building your documentation.	`...`
`use_directory_urls`	`_Flag`	Use directory URLs when building pages (the default). `use_directory_urls=off` emits `--no-directory-urls`.	`...`
`verbose`	`_Flag`	Enable verbose output.	`...`

new ¶

new(
    project_directory: str,
    /,
    *args: str,
    quiet: _Flag = ...,
    verbose: _Flag = ...,
    **flags: Any,
) -> Result

Create a new MkDocs project.

Parameters:

Name	Type	Description	Default
`quiet`	`_Flag`	Silence warnings.	`...`
`verbose`	`_Flag`	Enable verbose output.	`...`

serve ¶

serve(
    *,
    clean: _Flag = ...,
    config_file: _Value = ...,
    dev_addr: _Value = ...,
    dirty: _Flag = ...,
    dirtyreload: _Flag = ...,
    livereload: _Flag = ...,
    no_livereload: _Flag = ...,
    open: _Flag = ...,
    quiet: _Flag = ...,
    strict: _Flag = ...,
    theme: Literal["mkdocs", "readthedocs"]
    | Sequence[Literal["mkdocs", "readthedocs"]]
    | None = ...,
    use_directory_urls: _Flag = ...,
    verbose: _Flag = ...,
    watch: _Value = ...,
    watch_theme: _Flag = ...,
    **flags: Any,
) -> Result

Run the builtin development server.

Parameters:

Name	Type	Description	Default
`clean`	`_Flag`	Build the site without any effects of `mkdocs serve` - pure `mkdocs build`, then serve.	`...`
`config_file`	`_Value`	Provide a specific MkDocs config. This can be a file name, or '-' to read from stdin.	`...`
`dev_addr`	`_Value`	IP address and port to serve documentation locally (default: localhost:8000).	`...`
`dirty`	`_Flag`	Only re-build files that have changed.	`...`
`no_livereload`	`_Flag`	Disable the live reloading in the development server.	`...`
`open`	`_Flag`	Open the website in a Web browser after the initial build finishes.	`...`
`quiet`	`_Flag`	Silence warnings.	`...`
`strict`	`_Flag`	Enable strict mode. This will cause MkDocs to abort the build on any warnings. `strict=off` emits `--no-strict`.	`...`
`theme`	`Literal['mkdocs', 'readthedocs'] \| Sequence[Literal['mkdocs', 'readthedocs']] \| None`	The theme to use when building your documentation.	`...`
`use_directory_urls`	`_Flag`	Use directory URLs when building pages (the default). `use_directory_urls=off` emits `--no-directory-urls`.	`...`
`verbose`	`_Flag`	Enable verbose output.	`...`
`watch`	`_Value`	A directory or file to watch for live reloading. Can be supplied multiple times. May be repeated: a list emits the flag once per item.	`...`
`watch_theme`	`_Flag`	Include the theme in list of files to watch for live reloading. Ignored when live reload is not used.	`...`