docs.postmarketos.org Documentation

Thank you for considering to improve the documentation at docs.postmarketos.org! In order to do that, you will need to register a postmarketOS GitLab account.

Finding Sources

Click the pen icon in the top right to find out where exactly the source file for any document from docs.postmarketos.org is located. For example, the source code for the document you are reading right now is in the docs.postmarketos.org git repository under the path docs/dpo/index.md.

Building Locally

Clone the repository that you want to edit and run make to build the documentation the first time, and after making changes.

Example: docs.postmarketos.org

git clone https://gitlab.postmarketos.org/postmarketOS/docs.postmarketos.org.git
cd docs.postmarketos.org
make

Example: pmbootstrap

git clone https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git
cd pmbootstrap/docs
make

Running a Local Webserver

Use make run to run a local webserver, then open the URL shown in the output in your browser.

$ make run
python3 -m http.server -b 127.0.0.1 8080 -d _out
Serving HTTP on 127.0.0.1 port 8080 (http://127.0.0.1:8080/) ...

Additional Targets

Tip

Your shell may have tab completion for make targets.

The Makefile in docs.postmarketos.org also has these targets:

• all: build not only the documentation from this repository, but also from all external repositories (pmbootstrap, etc.)

• index, dpo, etc.: build only this Sphinx project

Contributions Welcome 😊

Once you have made a good change, you can do the usual git commit and create a merge request!