Skip to content

learningequality/studio-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Studio Docs

What is this?

This is the repository where user documentation for Kolibri Studio is maintained. To read the documentation visit kolibri-studio.readthedocs.io.

Building the docs locally

You will need an environment with make

# Create a Python 3 virtual environment using Virtualenvwrapper
# See: https://virtualenvwrapper.readthedocs.io/
mkvirtualenv -p python3 kolibri-docs

# Install Python requirements
pip install -r requirements.txt

Build and run:

make docs

You should now be able open the built docs with a web browser at docs/_build/html/index.html.

You can also have the docs automatically build and reload:

sphinx-autobuild docs docs/_build/html

You should now be able open the automatically-rebuilding docs with a web browser at http://127.0.0.1:8000.

License

Creative Commons License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License