Qualche buona alternativa per Sfinge per fornire la documentazione del software?

Question

Mi chiedevo se ci sono buone alternative a Sphinx quando voglio fornire la documentazione html statica per i progetti software. La Sfinge sembra ok ma è usata principalmente nell'area Python. Sono interessato a una soluzione che potrebbe potenzialmente essere utilizzata in tutti i tipi di progetti non solo relativi a Python.

Il mio obiettivo è quello di documentare roba in mark-down o qualcosa del genere e poi generare un sito HTML statico che sarà consegnato agli utenti (amministratori)

Ho visto anche Gollum, ma questo è legato alla GitHub :(

Answer 1

Pensi che sia un grosso problema che Sphinx è utilizzato principalmente nell'area Python? È vero che Sphinx è scritto in Python e principalmente orientato verso la documentazione Python. Ma IMHO, uno dei punti di forza è che può essere usato per documentare qualsiasi cosa

La Sfinge ti consente di fare esattamente quello che chiedi: "documento roba in markdown o qualcosa di simile e successivamente generare un sito html statico ". Sfinge usa restructuredtext, che è il bit "o qualcosa di simile".

Se si desidera provare qualcosa di un po 'diverso, vorrei suggerire docbook.

Answer 2

Si potrebbe voler considerare dare Gollum un altro aspetto. Menzionerò i miei pensieri su Gollum poiché le mie esigenze sembrano simili alle tue esigenze. Ho iniziato a utilizzare Gollum recentemente per la documentazione del progetto Rails e la mia esperienza fino ad ora è molto positiva. È sviluppato dagli utenti di Github ma non è legato al servizio Github e può essere utilizzato indipendentemente da Github.

È un progetto open source molto attivo con molti committer. Il framework è Sinatra e puoi eseguirlo facilmente sulla tua workstation personale. Mantengo un server Gollum in esecuzione sul mio computer di sviluppo e modifica direttamente i file Markdown e quindi visualizzo i risultati nel server Gollum locale. Questo è particolarmente utile se imposti il ​​tuo editor per aggiungere automaticamente gli aggiornamenti con un tasto. Quando sei pronto puoi generare un sito html statico dal tuo Gollum wiki usando il progetto this.

Inoltre, dal momento che utilizza git dietro le quinte, c'è un controllo delle versioni e tutta la potenza di git.