[bglug] Software Web per Documentazione Aziendale

Elena ``of Valhalla'' valhalla-l@trueelena.org
Mer 22 Gen 2020 11:51:33 CET


On 2020-01-21 at 18:39:22 +0100, Marco Cavallini wrote:
> > [...]
> > Il tutto deve essere editabile da interfaccia web e consultabile da
> > browser, meglio se OpenSource.
> > [...]
> Il kernel linux usa Sphinx
> http://www.sphinx-doc.org/en/master/
> 
> Una comoda alternativa  ReadTheDocs
> https://readthedocs.org/

che poi sono circa la stessa cosa, o sbaglio? readthedocs non 
semplicemente una piattaforma per pubblicare documenti realizzati con
sphinx?

 una soluzione che uso anche io, ma credo che manchi l'interfaccia web
per la modifica, a meno che esistano tool che non conosco (e nel caso
quali sono?)

Come alternativa, anche questa che uso, file reStructuredText (lo stesso
formato di sphinx) dentro ad un repository su un gitlab selfhostato.

Ha lo svantaggio di richiedere un gitlab, che  un discreto malloppone
(da noi  gi presente per altri motivi), ma a quel punto  comodo da
usare sia per chi preferisce scrivere nell'interfaccia web che per chi
preferisce usare il suo editor, offre la visualizzazione via web
(rendering automatico dei file reST), ma anche un modo comodo per avere
una copia locale di tutto quanto.

Ci sono un po' di ticket aperti per chiedere a gitlab di supportare
alcuni dei costrutti di sphinx, in modo da permettere l'unione delle due
cose (file in gitlab, editabili online, con preview veloce sul
repository e pubblicazione nei vari formati (html, pdf, epub) tramite
sphinx), che sarebbe una soluzione ideale, ma ancora non funziona
completamente.

https://gitlab.com/gitlab-org/gitlab/issues/36219

https://gitlab.com/gitlab-org/gitlab/issues/26687

-- 
Elena ``of Valhalla''


Maggiori informazioni sulla lista bglug