Faire son blog avec Sphinx

Dernière mise à jour: mars 18, 2017

Introduction

Sphinx est un super outil “à la LaTeX” qui permet de créer de la documentation pour un produit.

Avec un seul document on peut entre autre générer des pages HTML statique, des ePub, des PDF.

Il n’est pas exactement adapté à l’ecriture d’un blog mais je le trouve très simple à utiliser, et puis les CMS comme Wordpress, Drupal et Joomla sont pleins de bugs et de failles de sécurité. Sans compter la patate dont a besoin le serveur pour afficher les pages dignement. Sphinx compile les fichiers HTML statiques, donc une fois générés et déployés, le serveur envoye des fichiers tous bêtes au client. On peut difficilement faire plus simple : pas de PHP à tunner, pas de base données à configurer, pas de CMS à mettre à jour... c’est la fête \o/.

Créer la structure du Blog

Pour commencer il faut l’installer, malheureusement il n’est pas disponible dans les dépôts Ubuntu 14.04 ni 16.04, il faudra l’installer par pip

apt-get update
apt-get install python3-pip build-essential python3-markupsafe
pip3 install Sphinx

Pour commencer son projet, il faut lancer le script suivant:

sphinx-quickstart

Il pose tout un tas de questions, parmis celles interessantes, votre nom, celui du projet, sa langue, son dossier et les modules à activer. Pour le reste, utilisez la réponse par défaut.

Welcome to the Sphinx 1.5.3 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]: blog

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]:

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

The project name will occur in several places in the built documentation.
> Project name: Blog de Seba
> Author name(s): Sebastien DA ROCHA

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 []: 1.0.0
> Project release [1.0.0]:

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]: fr

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]:
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]:
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]:

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. \`make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]: n

Creating file blog/conf.py.
Creating file blog/index.rst.
Creating file blog/Makefile.

Finished: An initial directory structure has been created.

You should now populate your master file blog/index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

Editer le fichier de confifuration conf.py si vous voulez corriger une des questions:

cd blog
vim conf.py

Le contenu du site sera décrit dans des document rst, le premier est index.rst, c’est le fichier d’accueil de votre site. Nous verrons plutard comment le modifier.

Générer le site:

make html

Visualiser le site:

firefox _build/html/index.html&

Structure du site

Il faut ajouter ces pages (têtes de section) dans le toctree définit dans défine index.rst.

A partir de la sphinx parcourera tous les fichiers reST dans les sources. Dans ces fichiers prendra les sections précentes pour les rajouter à la table des contenus.

Pour ajouter une page, il faut créer un nouveau fichier reST.

Pour lier cette page à notre site, il faut la rajouter (sans l’extention) dans la section toctree du masterdoc (index.rst):

.. toctree::
   :maxdepth: 2

   Impression 3D
   Mise en place d'un blog avec Sphinx<sphinx_start>

Si vous n’aimez ni mettre des espaces dans les noms de fichiers ni avoir des noms de fichier à rallonge (surtout quand on utilise vim comme éditeur de texte). Vous pouvez mettre le titre de la page et mettre le nom du fichier entre “<” et “>”.

Attention, ce nom long est utilisé dans l’affichage de la structure du site, et non le titre principale (section) de la page.

En parlant de section, regardons le contenu de la page:

Impression 3D
=============

Dernière mise à jour: |today|

Mon imprimante
--------------

J'ai acheté une jolie MicroDelta Rework de eMotionTech

Le titre de la page est souligné avec des symboles “=”, il faut que cette ligne fasse exactement la taille du titre.

On voit que “Mon imprimate” est souligné avec des symboles ‘-‘, il s’agit d’un sous-section. Cette sous section aparaîtra automatiquement dans le menu de navigation.