UBports Documentation Website

This is the repository for the UBports documentation website served at docs.ubports.com.

Contribution guidelines

You can find ways to contribute here. Please follow all of the guidelines on that page, else your contribution will not be accepted.

Build instructions

The documentation can be built by running ./build.sh in the root of this repository. The script will also create a virtual build environment in ~/ubportsdocsenv if none is present. After the build is complete, you can view the documentation by opening the html files in your favorite browser (eg. firefox _build/html/index.html).

Update translations

To update translation templates, run ./update-translations.sh in the root of this repository.