Welcome to Mango Documentation via MkDocs

Hosted on Read the Docs here.

Getting Started

Install and serve:

$ pip install -r docs/requirements.txt
$ mkdocs serve

Any changes pushed to the docs branch would be automatically published.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

External resources

Here are some external resources to help you learn more about MkDocs.