Documentation for AliceOS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
applets
brand
docs
media
system
.htaccess
404.md
README.md
dist.md
index.html
index.md
metadata.yaml
serve.py
template.html
versions

README.md

AliceOS Docs

The documentation for AliceOS

Requirements

You will need Python 2 and documentation-builder from Canonical to run the scripts necessary.

Get documentation-builder ›

Building

If you intend to just build the docs folder, run the following command:

./serve.py build-only

If you plan to test locally, run the following command:

./serve.py build-local-test

The website will be available for local viewing at localhost:8000.

Pushing to the repository

Ensure that the docs folder remains when pushing; GitHub watches this folder to use that as the site.