PimenTech Garage : On code aussi en Français

Note

Le script "rest2site" écrit en shell a été abandonné. En effet, le souhait d'utiliser des tags, des commentaires, de contrôler le html m'a mécaniquement dirigé vers Django.

English readers

Technical documentations are now written in english (translations in progress..).

Questions / Réponses

C'est quoi ce site ?

Des documentations en vrac, organisées par tags. Le site principal de PimenTech se trouve ici : http://www.pimentech.fr .

Pourquoi "Garage" ?

Parce que PimenTech Labs, c'est banal et prétentieux.

Contexte d'utilisation

Nous travaillons sur un grand nombre de projets et nous manquons toujours de temps pour communiquer et faire des documentations. Quand ça nous arrive, nous faisons du LaTeX pour le papier, du html pour notre site, et des mails pour des petites infos a partager.

L'idée est de générer des documentations au format reStructuredText_ .

Fonctionnement

Tout ajout de fichier ".rst" dans l'arborescence CVS d'un module candidat [1] apparaîtra sur le site à chaque lancement de la fonction build_documents présent dans build_documentation.py.

Note

L'extension officielle pour les fichiers RestTructured Text est '.txt', mais je trouvais ça trop contraignant : on a déjà plein de .txt dans nos sources.

[1]les modules qui seront présents dans jim:/home/fredz/src

TODO

  • Améliorer la recherche par tags : tag/python+crm pour lister les documents contenant ces deux tags.
  • La façon actuelle de récupérer les tags se fait par du grep. Il faudrait plonger dans le code de rst, pour ajouter des directives, ce qui permettrait notament d'ajouter des liens sur les tags dans le document.

Commentaires

fredz Décembre 13, 2006 at 4:42 après-midi

C'est nettement plus beau comme ça

David, biologeek Juin 27, 2007 at 6:13 après-midi

Très intéressant ce garage !

J'ai pas encore fait le tour de toutes les places mais c'est vraiment prometteur... merci :-).

fredz Juin 27, 2007 at 6:23 après-midi

Merci !
Le code avance beaucoup plus vite que la doc, il faut qu'on mette à jour...

Comments

blog comments powered by Disqus