Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Weka Wiki

Not really a wiki, but replacing some of the content that was hosted on weka.wikispaces.com before it shut down. Uses mkdocs to generate the content.

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 2.7

    virtualenv -p /usr/bin/python2.7 venv
    
  • Python 3.6 (Python 3.5 works as well)

    virtualenv -p /usr/bin/python3.6 venv
    
  • Install the mkdocs package

    ./venv/bin/pip install mkdocs
    

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:

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 && mkdocs serve