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

• Fondamentalement, [Entrée] convient, mais vous devez entrer les questions suivantes.
• Nom du projet
• Nom de l'auteur
• version
• Explication détaillée de 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]:
・ ・ ・

• Une fois terminé, les fichiers suivants seront créés
• Makefile
• index.rst
• conf.py
• make.bat
• _static/
• _build/
• _templates/

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.