A static site for OpenCloning, hosted at docs.opencloning.org.
To install the dependencies, we used poetry (see poetry installation instructions). In the source directory run:
# install dependencies in ./.venv
poetry installThe documentation uses text from the OpenCloning repositories, via mkdocs include. This allows us to keep a single version of the documentation.
git submodule update --init --recursive# activate virtual environment
source .venv/bin/activate
# start dev server
mkdocs serve -a localhost:8001Go to http://127.0.0.1:8001/ and you should see the page.
Full documentation on the theme and static site generator used (Material for MkDocs) can be found in the official documentation. There is some extra info in CONTRIBUTING.md.
The content of this website are licensed under the Creative Commons Attribution 4.0 International License.
See contributing.md.