Créer un projet documenté

_images/lg.jpg
Auteur

Gilles

Blog

La technologie dans tous ses états 1

Societe

VoRoBoTics 2

Entity

VoLAB 2

Page principale

Readme 3

Date de création

18/04/2023

Date dernière maj

10/05/2023

Configuration requise

Python

Sphinx

Vérifier tous les paquets Python installés

  • C:

  • pip list

J’utilise aussi Visual Studio Code

Démarche

  1. Créer le dossier du projet « creation-docs »

  2. Se positionner dans ce dossier

  3. Lancer cmd

  4. lancer sphinx-quickstart

  5. Création automatique des dossiers build et source

  6. Se positionner dans le dossier « creation-doc »

  7. lancer cmd

  8. Lancer make html

Tables et index

Informations

Installations de Python et Sphinx 4

Sphinx-doc 5

A ReStructured Text Primer 6

Thèmes page html Sphinx 7

Visual Studio Code 8

Todo ; regarder les directives sphinx cloud