README.md

OpenAEV Documentation Space

Introduction

This is the main repository of the OpenAEV Documentation space. The online version is available directly on docs.openaev.io.

Development (local setup)

Prerequisites

• Python 3

Build and serve locally

Unix-like (Linux, BSD, macOS...)

Run this shell script from the root of the cloned repository:

$ ./serve.sh

This will create a virtual environment and install the dependencies, and serve the docs at http://localhost:8000.

Windows

Please follow the Manual instructions below.

Alternative: manual local build and serve

Clone the repository:

$ git clone git@github.com:OpenAEV-Platform/docs.git

Install dependencies; consider a virtual environment for doing so

$ cd docs/
$ python -m venv .venv
$ .\.venv\Scripts\Activate.ps1
$ pip install -r requirements.txt

Launch the local environment (if you have created a virtual environment, remember to activate it as above):

$ mkdocs serve
Starting server at http://localhost:8000/

Upgrade dependencies

$ cd docs/
$ source .venv/bin/activate
$ pip install --upgrade -r requirements.txt
$ pip install --upgrade git+https://TOKEN@github.com/squidfunk/mkdocs-material-insiders.git

Deploy the documentation

Update the source

Commiting on the main branch does not impact (for now) the deployed documentation, please commit as many times as possible:

$ git commit -a -m "[docs] MESSAGE"
$ git push

Deploy and update the current version

With the right version number (e.g. 3.3.X):

$ mike deploy --push [version]

Deploy a new stable version

With the right version number (e.g. 3.3.X), update the latest tag:

$ mike deploy --push --update-aliases [version] latest

Useful commands

List known versions:

$ mike list