Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Your Documentation

The source for your documentation is in this directory. Our documentation uses extended Markdown, as implemented by MkDocs.

Building the documentation

  • Install requirements: pip install -r requirements.txt
  • From the root directory, cd into the docs/ folder and run:
    • python autogen.py
    • mkdocs serve # Starts a local webserver: localhost:8000
    • mkdocs build # Builds a static site in site/ directory
    • mike deploy {version} latest --update-aliases # put value in {version} and make it the latest version
    • mike set-default --push latest # To deploy the docs online