¿Alguna buena alternativa para Sphinx para proporcionar documentación de software?

Question

me preguntaba si hay alguna buena alternativa a Sphinx cuando quiero proporcionar documentación html estática para proyectos de software. Sphinx parece estar bien, pero se usa principalmente en el área de Python. Estoy interesado en una solución que podría ser utilizada en todo tipo de proyectos no solo relacionados con Python.

Mi objetivo es documentar cosas en rebaja o algo así y después generar un sitio HTML estático que será entregado a los usuarios (administradores)

También he visto a Gollum, pero esto está ligado a GitHub :(

Answer 1

¿Cree que es un gran problema que Sphinx se utiliza principalmente en el área de Python? Es cierto que Sphinx está escrito en Python y principalmente orientado a la documentación de Python. Pero en mi humilde opinión, uno de los puntos fuertes es que puede ser utilizado para documentar cualquier cosa.

Sphinx le permitirá hacer exactamente lo que pide: "document cosas en rebajas o algo así y luego generar un sitio html estático ". Sphinx usa restructuredtext, que es el bit "o algo así".

Si quiere probar algo un poco diferente, sugeriría docbook.

Answer 2

Es posible que desee considerar dar Gollum otra mirada. Mencionaré mis pensamientos sobre Gollum ya que mis necesidades suenan similares a sus requisitos. Empecé a usar Gollum recientemente para la documentación del proyecto Rails y mi experiencia hasta ahora es muy positiva. Es desarrollado por la gente en Github pero no está vinculado al servicio de Github y se puede usar independientemente de Github.

Es un proyecto de código abierto muy activo con muchos committers. El marco es Sinatra y puedes ejecutarlo fácilmente en tu estación de trabajo personal. Mantengo un servidor Gollum ejecutándose en mi máquina de desarrollo y edito los archivos Markdown directamente y luego veo los resultados en el servidor local Gollum. Esto es especialmente bueno si configura su editor para agregar automáticamente sus actualizaciones con una pulsación de tecla. Cuando esté listo, puede generar un sitio html estático desde su wiki de Gollum usando el proyecto this.

Además, dado que utiliza git detrás de las escenas, está incorporado el control de versiones y todo el poder de git.