Expériences faites et à faire
Avis
Javascript est requis !
Cette page embarque des scripts écrits en javascript. À priori, cela devrait fonctionner sur n'importe quel navigateur assez récent, pour peu qu'il supporte javascript (et que javascript ne soit pas désactivé).
Note
Page de démos (faites et à faire)
Cette page est là pour montrer quelques démos supplémentaires à propos de Sphinx.
Quelques idées ou démos
Liens externes
L'extension sphinx.ext.extlinks permet de définir des rôles rST pour rapidement insérer un lien externe. Quelques exemples des alias définis dans mon conf.py :
- :issue:`1` donnera ce lien :issue:`1` (bug signalé via Bitbucket).
- :wfr:`Grim_Dawn` donnera ce lien :wfr:`Grim_Dawn` (Wikipédia en français).
- :wen:`Grim_Dawn` donnera ce lien :wen:`Grim_Dawn` (Wikipédia en français).
- :ffaddonfr:`nosquint` donnera ce lien :ffaddonfr:`nosquint` (page d'un greffon pour Firefox en français).
- :ffaddonen:`nosquint` donnera ce lien :ffaddonen:`nosquint` (page d'un greffon pour Firefox en anglais).
- :stpkg:`GitGutter` donnera ce lien :stpkg:`GitGutter`.
Meilleur thème ?
- Read-the-doc semble le mieux !
- SphinxTrab semble intéressant.
- Basicstrap aussi.
- Sphinx-bootstrap-theme idem.
Réduire les dépendances inutiles
- Enlever gnuplot_embed.html ?
Une extension Sphinx pour Youtube
Voici, par exemple, la première vidéo du concert du Trio ELM donné à l'ENS Cachan en 2014 :
Une expérimentation : ajouter facilement des couleurs en rST ?
J'utilise la balise .. raw:: html pour embarquer des définitions de rôles dans les fichiers .rst écrits pour ces pages webs, et ces rôles sont mis en relation avec des styles CSS définis dans .templates/layout.html le template Jinja qui contrôle l'apparence et le rendu de toutes mes pages produites avec Sphinx. C'est une question courante concernant Sphinx.
Notamment, les différentes couleurs suivantes sont disponibles : black gray silver white maroon red magenta fuchsia pink orange yellow lime green olive teal cyan aqua blue navy purple.
Ceci est rendu possible avec:
- .special.rst inclus en haut de chaque fichier rST (nécessaire). :red:`Nouveau :` en fait, il est possible d'utiliser la variable rst_prolog dans le fichier conf.py de sphinx pour ajouter du contenu reStructuredText qui sera ajouté en en-tête de chaque page, et donc dans ce cas, on peut utiliser .. include:: .special.rst (voir cette modification :bbchangeset:`f4b9d9d565f71849ca848232a9e5a0daf99c1484`),
- hacks.css inclus dans chaque page web via les templates.
Liste des couleurs rajoutées :
- la couleur :black:`black`;
- la couleur :gray:`gray`;
- la couleur :silver:`silver`;
- la couleur :white:`white` (white);
- la couleur :maroon:`maroon`;
- la couleur :red:`red`;
- la couleur :magenta:`magenta`;
- la couleur :fuchsia:`fuchsia`;
- la couleur :pink:`pink`;
- la couleur :orange:`orange`;
- la couleur :yellow:`yellow`;
- la couleur :lime:`lime`;
- la couleur :green:`green`;
- la couleur :olive:`olive`;
- la couleur :teal:`teal`;
- la couleur :cyan:`cyan`;
- la couleur :aqua:`aqua`;
- la couleur :blue:`blue`;
- la couleur :navy:`navy`;
- la couleur :purple:`purple`.
Tests JavaScript avec TimeAgo
Affiche des dates avec un <abbr class="timeago"> :
Fin des écrits de l'ENS en MP* : 10 Mai 2011.Valideurs CSS et HTML
Deux liens vers les valideurs CSS et HTML du W3C étaient intégrés dans la barre latérale de chaque page.
Ils n'y sont plus, mais ils sont encore accessibles ici :
- XHTML 4.01,
- et CSS 3,
- et RSS 2.0.
Une des deux images était codée en base64, pour essayer.
L'autre est :
Résultats attendus :
- aucune erreur sérieuse pour les feuilles CSS !
- aucune erreur grave pour les pages XHTML 1.0 Transitional !
- aucune erreur pour le flux RSS !
Avis
Mes pages ne sont plus correctes sémantiquement ...
Aucunes pages ne passent désormais le test XHTML, à cause de bout de code écrits par des extensions non officielles de Sphinx (sphinx.ext.gnuplot par exemple).
Aucunes pages ne passent désormais le test CSS, à cause de la feuille buttons.css.
:red:`Mais j'y travaille ! J'essaie de nétoyer au mieux les modèles de pages, et le code de chaque pages. Dans ce but, tout retour est le bienvenu ! Le traqueur de bug est là pour ça :` https://bitbucket.org/lbesson/web-sphinx/issues/new/.
D'autres ajouts
sphinx_git
Une liste des dernières modifications. Une liste plus complète peut-être consultée avec le flux rss.
sphinx_pyreverse
sphinxcontrib.bitbucket
- Un signalement d'erreur via bitbucket :bbissue:`1`.
- Et une modification, indiquée via son hash long (822ba395fceeac8e8a2a25b571503ec790e4fe35) :bbchangeset:`822ba395fceeac8e8a2a25b571503ec790e4fe35`.
Citation random !
Cette ligne Bash affiche une citation aléatoire. Actuellement, ~/.quotes.txt est une liste très complète des meilleurs citations de Kaamelott.
Cette liste est obtenue à partir des deux scripts suivants, depuis les données du superbe projet WikiQuote :
- quotes.sh pour télécharger et analyser les citations,
- makequotes.sh pour construire un fichier quotes.txt.