Mémo sur Sphinx Partie 1 (Création d'un projet)

Sphinx est un outil de documentation écrit en Python. Contrairement à Word, vous pouvez écrire des documents comme un programme. Page de l'association des utilisateurs de Sphinx Japan

Notes d'étape sur la création et la construction d'un projet.

environnement

OS:Mac OS X 10.9.5 Python:Ver.2.7.7

Comment faire un projet

$ sphinx-quickstart
・ ・ ・
#Nom du projet et nom de l'auteur.
The project name will occur in several places in the built documentation.
> Project name: #Titre du projet
> Author name(s): #Nom de l'auteur
・ ・ ・
#Version du projet
Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 2014.09.27
> Project release [2010.09.27]:
・ ・ ・

Comment construire

Sortie en HTML

$ make html

Le HTML est généré dans le dossier _build / html. Ouvrez ** index.html ** et vous avez un document.

Sortie avec epub

$ make epub

Généré dans le dossier _build / epub.

Sortie au format Latex

$ make latex

Généré dans le dossier _build / latex.

Recommended Posts

Mémo sur Sphinx Partie 1 (Création d'un projet)
Est-ce que ça va avec un tel patch? (Mémo sur le simulacre ~ Partie 2 ~)
Commandes pour créer un nouveau projet django
Remarques sur la création d'outils de mise en forme de texte
Mémo d'apprentissage automatique d'un ingénieur débutant Partie 1
DJango Memo: depuis le début (création d'une vue)
Un mémo que j'ai écrit un tri de fusion en Python
Un mémo lors de la création d'un environnement python avec miniconda
Mémo d'apprentissage automatique d'un ingénieur débutant Partie 2
Notes sur la création d'un environnement python par les débutants
Un mémo sur la création d'une application Django (Python) avec Docker
4. Création d'un programme structuré
[Pour mémoire] Linux Partie 2
[Python] Mémo sur les fonctions
Liste de rédaction de mémo partie 2
Un mémorandum sur Nan.
Création d'outils de grattage
Mémo de base Python - Partie 2
Une note sur __call__
Une note sur le sous-processus
Mémo du didacticiel FastAPI, partie 1
Une note sur mprotect (2)
Créer un chargeur de jeu de données
Mémo de base Python - Partie 1
Sortie PDF en utilisant l'extension Latex avec Sphinx
Mémo sur Sphinx Partie 1 (Création d'un projet)
Numéroter les chapitres et les sections lors de la sortie au format PDF (rst2pdf) avec Sphinx
Une histoire sur la création d'un système d'exploitation compatible UNIX / Linux à partir de zéro
Une note lors de la création d'un graphe dirigé à l'aide de Graphviz en Python
Une note sur le comportement de bowtie2 lors de plusieurs coups