Skip to content

API for running mkdocs #1240

@Hecatron

Description

@Hecatron

Hi,
I just wanted to ask is it safe to call the functions within __main__.py directly to run mkdocs from some other python code?

Recently I've been using a script to run mkdocs as a shortcut, as an example
https://github.com/ASoftTech/Gbd.IO.Serial/blob/master/Docs/MkDocs/build.py
But this is using subprocess instead of calling mkdocs via any sort of API

I'm thinking of writing some code as part of a Scons Builder for building mkdocs sites and wanted to know if those functions such as serve_command() / build_command() can be considered an API or are subject to change.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions