Pregunta

Necesito un sistema de documentación para un proyecto de PHP y yo quería que fuera capaz de integrar la documentación externa (casos de uso, el alcance del proyecto, etc.) con la documentación generada a partir de comentarios de código. Parece que phpDocumentor tiene exactamente el conjunto de características de la derecha, pero la documentación externa debe estar escrito en DocBook que es demasiado complejo para nuestro equipo.

Si estuviera en Python, esfinge sería casi perfecta para este trabajo (el resto es definitivamente más simple que DocBook). ¿Hay alguna manera de que pueda integrar la documentación ReST externa con los documentos extraídos de phpdoc? ¿Debo separar la documentación externa (por ejemplo. Resto utiliza para aplicaciones externas y para phpdoc interno)? ¿O usted tiene una mejor sugerencia para la gestión de la documentación externa?

¿Fue útil?

Solución

Puede convertir descanso para DocBook usando Pandoc.

Otros consejos

convertir mensajes wordpress en estilo DocBook. aquí está la muestra.

http://hashfold.com/techfold/wordpress -cómo-a-generar-docbook-estilo-postes /

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top