Documentation (Web) de ScoDoc, en MkDocs.

Go to file

viennet 8528217d5f Documentation API et nouveaux samples		2024-07-27 14:34:32 +03:00
docs	Documentation API et nouveaux samples	2024-07-27 14:34:32 +03:00
tools	Formattage doc API	2022-10-29 09:16:14 +02:00
.gitignore	Ignore vscode files	2022-07-16 15:02:23 +02:00
LICENSE	Initial commit	2020-09-21 16:08:23 +02:00
mkdocs.yml	Liens vers install Debian 12	2024-05-30 15:32:10 +02:00
README.md	Doc évaluation et reprise page BUT.	2024-03-17 22:50:27 +07:00

Documentation de ScoDoc

Documentation (Web) de ScoDoc, en MkDocs.

Version en ligne sur scodoc.org.

Historique

L'ancienne documentation de ScoDoc7, hébergée au LIPN sur une plate-forme Trac, a été traduite en Markdown en septembre 2020 et passée sous git.

Le site est depuis hébergé sur [https://scodoc.org].

Il est recommandé de créer un virtualenv:

python3.11 -m venv venv
source venv/bin/activate

(n'importe quelle version de python récente fera l'affaire).

Puis installer les composants suivants dans ce virtualenv:

pip install mkdocs
pip install pymdown-extensions
pip install mkdocs-material
pip install mkdocs-plugin-inline-svg

Pour générer le site:

mkdocs build

Pour lancer un serveur local permettant d'afficher la doc, avec rafraichissement automatique dès qu'un fichier source est modifié:

mkdocs serve

Pour le reste voir la documentation de MkDocs.