diff --git a/doc/contributing/documenting.md b/doc/contributing/documenting.md index 5324864709040417a0bd0e5d09f87a109d5bc6c2..0645b612207273a0b187217ef5a072ed9770419c 100644 --- a/doc/contributing/documenting.md +++ b/doc/contributing/documenting.md @@ -39,12 +39,13 @@ git checkout develop ```bash python3 -m venv venv source venv/bin/activate - python -m pip install mkdocs - python -m pip install mkdocs-material - python -m pip install mike +python -m pip install mkdocs +python -m pip install mkdocs-material +python -m pip install mike ``` 4) Wait for all downloads to finish and start the mkdocs server + ```bash mkdocs serve ``` @@ -53,5 +54,4 @@ mkdocs serve Before committing, you should make sure that the local mkdcocs server's terminal is not producing any INFO/WARNING message regarding your contributions. - > The documentation website supports branches, so your accepted changes will be reflected to the develop branch which becomes the Release branch after each corresponding cycle.