General overview

Contains the documentation for the user-friendly deep-learning (UFDL) framework.

Generated documentation is available at:

https://ufdl.cms.waikato.ac.nz/ufdl-api/

Installation

mkdocs works with Python 2.7 and 3.x.

Best approach is to install mkdocs (>= 0.16.0) in a virtual environment (venv directory):

• Python 3.7

  virtualenv -p /usr/bin/python3.7 venv
  

• Install the mkdocs package (newer versions screw up the TOC navigation!)

  ./venv/bin/pip install mkdocs==1.0.4
  

Content

In order for content to show up, it needs to be added to the configuration, i.e., in the pages section of the mkdocs.yml file.

Some pointers:

• Images and media
• Linking
• mkdocs.yml

Build

mkdocs is used to generate HTML from the markdown documents and images:

./venv/bin/mkdocs build --clean

Testing

You can test what the site looks like, using the following command and opening a browser on localhost:8000:

mkdocs monitors setup and markdown files, so you can just add and edit them as you like, it will automatically rebuild and refresh the browser.

./venv/bin/mkdocs build --clean && ./venv/bin/mkdocs serve

Deploying

You can deploy the current state to Github pages with the following command:

./venv/bin/mkdocs gh-deploy --clean