Soutenez La Quadrature du Net contre ACTA et au-delà !

Tag: Python

Je fais des manpages en rest avec sphinx !

J'aime le restructuredtext, j'apprécie sa syntaxe non invasive, il me sert quasiment pour tout :

  • doctests (bien entendu)
  • ce blog /o\
  • mais j'apprécie par dessus tout son utilisation couplée à sphinx je m'en sers en permanence pour faire des documentations.

Une de mes utilisations récentes est la prise de notes (et oui en vieillissant il faut se rendre à l'évidence, on ne peut se rappeller de tout).

One_liners shells ou autres joyeusetés du genre, certes j'ai rempli plusieurs fois mon bashrc de functions, mais là c'est pareil faut se rappeler du nom qu'on leur a donné.

J'ai donc un raccourci vers le build html dans mon navigateur. Je m'étais promis cependant de me faire des man_pages (tellement plus pratiques). Et ce matin en testant le build epub, voilà t-il pas que je trouve un build pour man dans le Makefile !

3 minutes plus tard après avoir étendu mon $MANPATH à mon home, et modifié la ligne du Makefile en conséquence je peux dorénavant taper dans mon terminal

MacBookPro-2:~ jpcw$ man notes

NOTES(1)                                                       notes                                                      NOTES(1)

NAME
       notes - notes Documentation

                  Contents:

...

Et ça c'est la classe :)

Edit

solevis me fait remarquer que je n'avais pas mis les sources

  • updater son .bashrc si besoin

    MANPATH=$HOME/man
    export MANPATH
    
  • puis créer un rep man dans son home

    mkdir -p ~/man/man1
    
  • renseigner le path dans le Makefile:

    $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(HOME)/man/man1
    

Enjoy !

Hello World!

Tiens un nouveau blog !

Ce premier billet me permet de remercier Rafael Martins pour son blohg.

Il m'a tout l'air d'être l'outil que je cherchais depuis un moment déjà.

J'avoue que j'ai hésité avec Pelican, bref j'ai tranché et l'on verra bien à l'usage.