MkDocs

Project documentation with Markdown.

YAML Configuration

mkdocs:

  • config-file

    • Path to the MkDocs configuration file (mkdocs.yml).
    • If this field is omitted, Docstand searches for mkdocs.yml under the repository and uses it to build documentation.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.5 CPU with 1920 MiB RAM.

  • options:

    Below is the list of supported options:

    -f, --config-file FILENAME      Provide a specific MkDocs config
    -s, --strict                    Enable strict mode. This will cause MkDocs
                                    to abort the build on any warnings.
    -t, --theme [readthedocs|mkdocs]
                                    The theme to use when building your
                                    documentation.
    -e, --theme-dir PATH            The theme directory to use when building
                                    your documentation.
    

Resolving Dependencies

Docstand recursively searches your repository for requirements.txt and runs pip install --user -r at each directory containing the file.

Examples

  • With mkdocs set to default

    docstand:
      mkdocs: default
    
  • With custom machine:

    docstand:
      mkdocs:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With customized mkdocs

    docstand:
      mkdocs:
        options:
          -s:
          --theme-dir: path/to/custom/theme
    

results matching ""

    No results matching ""