2022-08-27 09:34:00 +02:00
|
|
|
# Documentation de ScoDoc
|
2020-09-21 16:30:27 +02:00
|
|
|
|
|
|
|
|
Documentation (Web) de ScoDoc, en [MkDocs](https://www.mkdocs.org/).
|
|
|
|
|
|
2020-10-22 11:13:36 +02:00
|
|
|
Version en ligne sur [scodoc.org](https://scodoc.org).
|
|
|
|
|
|
|
|
|
|
## Historique
|
2022-10-29 09:16:14 +02:00
|
|
|
|
2021-01-29 13:41:40 +01:00
|
|
|
L'ancienne documentation de ScoDoc7, hébergée au LIPN sur une plate-forme
|
2020-09-21 16:30:27 +02:00
|
|
|
[Trac](https://trac.edgewall.org/), a été traduite en
|
|
|
|
|
[Markdown](https://www.markdownguide.org/basic-syntax/) en septembre
|
|
|
|
|
2020 et passée sous git.
|
|
|
|
|
|
|
|
|
|
Le site est depuis hébergé sur [https://scodoc.org].
|
|
|
|
|
|
2022-10-29 09:16:14 +02:00
|
|
|
## Installation mkdocs
|
|
|
|
|
|
|
|
|
|
Il est recommandé de créer un virtualenv:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
python3.11 -m venv venv
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
puis d'y installer les composants suivants:
|
2020-09-21 16:30:27 +02:00
|
|
|
|
2022-10-29 09:16:14 +02:00
|
|
|
```bash
|
|
|
|
|
pip install mkdocs
|
|
|
|
|
pip install pymdown-extensions
|
|
|
|
|
pip install mkdocs-material
|
|
|
|
|
pip install mkdocs-plugin-inline-svg
|
|
|
|
|
```
|
2020-09-21 16:30:27 +02:00
|
|
|
|
2022-10-29 09:16:14 +02:00
|
|
|
Pour générer le site:
|
2020-09-21 16:08:23 +02:00
|
|
|
|
2022-10-29 09:16:14 +02:00
|
|
|
```bash
|
|
|
|
|
mkdocs build
|
|
|
|
|
```
|
