Resultados de la búsqueda a petición "documentation-generation"
¿Cuál es la relación entre docutils y Sphinx?
Parece que hay una gran cantidad de herramientas de documentación para Python. Otro que me he encontrado es epydoc. Parece que Sphinx es el estándar de facto, porque se usa para generar los documentos oficiales de Python. ¿Alguien puede resolver ...
Reemplazo de cadenas de documentos de Python [cerrado]
He escrito unepytext [http://epydoc.sourceforge.net/epytext.html]adescanso [http://docutils.sourceforge.net/docs/user/rst/quickref.html]convertidor de marcado, y ahora quiero convertir todas las cadenas de documentos en toda mi biblioteca de ...
¿Cómo omito los valores de las variables en Sphinx?
Tengo algunas variables de nivel de módulo que tienen valores largos y poco interesantes que me gustaría excluir de la documentación generada automáticamente. ¿Hay alguna forma de hacer esto? Por ejemplo, en mi fuente Python tengo algo ...
Genere archivos HTML / Ayuda a partir de la documentación de VS 2010 C # XML
Estoy buscando una buena herramienta para crear archivos HTML / Ayuda a partir de mi documentación VS2010 XML. He encontrado algunas herramientas comerciales, como Herramienta de documentación ...
JSDoc: Estructura de objeto de retorno
¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? He encontrado el@return {{field1: type, field2: type, ...}} description sintaxis y lo probé: /** * Returns a coordinate from a given mouse or touch event * ...
¿Puede la función de documento napoleón de la esfinge devolver múltiples argumentos?
Estoy tratando de usar el estilo del código de Google para documentar una función para la que luego uso sphinx con la extensión napoleon para crear documentación. La función es inusual porque devuelve dos argumentos. No creo que Napoleón maneje ...
Cómo usar LuaDoc con LuaForWindows
La pregunta está en el título: ¿cómo usar LuaDoc con LuaForWindows? En mi instalación de Lua, tengo un luadoc_start.bat pero la ventana de comandos se cierra tan pronto como se abre. Desde allí no sé qué más puedo hacer. Alguna ayuda ? Gracia
Se puede utilizar LaTeX para producir cualquier documentación que acompañe al software? [cerrado
Aunque está relacionado conesta pregunta sobre el uso de LaTeX fuera de las matemáticas y la academia [https://stackoverflow.com/questions/39029/is-latex-used-outside-mathematics-and-academia] , Me pregunto específicamente si alguien usa o está ...
Auto documentando REST API en PHP
phpDocumentor parece ser el estándar para documentar código PHP, aunque tengo que preguntarme por qué no se ha actualizado en años ...? Sin embargo, no parece adecuado para documentar los puntos de entrada para una API REST; IE, puntos de ...
VS2010: el archivo de documentación XML autogenerado no se actualiza
Tengo un proyecto C # en vs2010 que genera un archivo de documentación XML, donde configuré la ruta de salida del archivo generado a la ruta de salida del proyecto. Mi problema es que el archivo no se actualiza cuando la ruta al archivo ...