2012-06-19 15 views
13

Actualmente estoy escribiendo algunos extensa documentación mediante la esfinge por un sitio web bastante complejo Django. He estado trabajando en esto en la casa y antes de que salga pronto quiero dejar detrás documentación detallada accesible por los nuevos desarrolladores/administradores del sitio.Alojamiento privado Documentación Sphinx

Mi pregunta es ¿cuáles son mis opciones para acoger esta documentación? Yo preferiría que fuera privado. También los documentos se refieren a un sitio web, no a un paquete de Python. Por estas dos razones Pienso que leen el Docs puede no ser la opción más adecuada.

Me encontré con django-sphinxdoc, aunque esto requiere la configuración de Haystack como back-end. ¿No hay una forma de simplemente server los documentos usando la búsqueda js incorporada? ¿O un servicio que permite el alojamiento privado de los documentos?

Cualquier opción sería muy apreciada.

Respuesta

14

Sphinx puede generar archivos estáticos .html (make html). Coloque esos archivos HTML en un servidor web interno y debería estar listo para continuar.

+0

¿Funciona esto con la búsqueda js? –

+2

Sí. La búsqueda de JS es solo JS con un índice estático (que se genera al compilar su documentación). –

6

Sentí la misma necesidad de alojar la documentación de forma privada. Así que he creado un servicio web que admite el alojamiento de documentación privada de Sphinx: HasDocs.

http://www.hasdocs.com/

Se debería eliminar la necesidad de configurar su propio servidor web, etc. Puede sincronizar los repositorios de GitHub y permisos. Los proyectos privados tienen documentos privados a los que solo pueden acceder quienes tienen los privilegios adecuados. La documentación se reconstruye cada vez que inserta un nuevo código en su repositorio de GitHub.

Actualmente se encuentra en versión beta y es compatible con Sphinx, Jekyll y Javadoc como generador de documentación. Por favor, inténtelo y cualquier comentario será muy apreciado.

+0

¿Eres compatible con bitbucket? –

+4

Disculpe al ver que http://www.hasdocs.com parece haberse ido. ¿Alguien más tiene alguna buena solución para esto? –

+0

@BrianKing parece que la fuente está disponible en [https://github.com/narrowcast/hasdocs.com](https://github.com/narrowcast/hasdocs.com) – Reinbach

-1

Ver la respuesta a esto question (descripción completa, hice la pregunta, no obtuve ninguna respuesta hice un poco de investigación y codificación y publiqué la respuesta, así que mientras funciona puede haber mejores por ahí. Estaría muy agradecido. si alguien los señala.)

Este repositorio de gitlab muestra un ejemplo de trabajo here.

Utiliza static password protection y también se discute en este issue.

Cuestiones relacionadas