Usar esfinge con Markdown en lugar de RST
Odio RST pero amo a la esfinge. ¿Hay alguna forma en que la esfinge lea Markdown en lugar de
212
Sphinx es una herramienta que facilita la creación de documentación inteligente y hermosa. Sphinx es especialmente adecuado para la documentación de Python, pero es una herramienta de propósito general que se puede utilizar para documentar cualquier cosa.
Odio RST pero amo a la esfinge. ¿Hay alguna forma en que la esfinge lea Markdown en lugar de
Estoy tratando de usar Sphinx para documentar un proyecto de más de 5,000 líneas en Python. Tiene unos 7 módulos base. Hasta donde sé, para usar autodoc necesito escribir un código como este para cada archivo en mi proyecto: .. automodule:: mods.set.tests :members: :show-inheritance: Esto es...
¿Cómo insertar una referencia cruzada en una página reST / Sphinx a un subencabezado o un ancla en otra página en el mismo conjunto de
Sphinx no genera documentos para __init __ (self) de forma predeterminada. He probado lo siguiente: .. automodule:: mymodule :members: y ..autoclass:: MyClass :members: En conf.py, estableciendo la siguiente sólo se añade la __init __ (self) docstring a la cadena de documentación de clase (...
Estoy tratando de empezar con Sphinx y parece que tengo problemas implacables. Mando: docs/sphinx-quickstart Respondo todas las preguntas y todo funciona bien. Mando: docs/ls Todo parece normal. Resultado:build Makefile source Mando: sphinx-build -d build/doctrees source build/html Parece...
Estoy usando sphinx y el complemento autodoc para generar documentación API para mis módulos de Python. Si bien puedo ver cómo documentar bien parámetros específicos, no puedo encontrar un ejemplo de cómo documentar un **kwargsparámetro. ¿Alguien tiene un buen ejemplo de una forma clara de...
Cerrado . Esta pregunta debe estar más enfocada . Actualmente no acepta respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que se centre en un solo problema editando esta publicación . Cerrado hace 2 años . Mejora esta pregunta...
Estoy tratando de crear una lista correctamente anidada usando el siguiente código (siguiendo los documentos de Sphinx y docutils ): 1. X a. U b. V c. W 2. Y 3. Z Espero que esto dé como resultado dos OLs, pero obtengo el siguiente resultado: <ol class="arabic simple">...
Estoy usando Sphinx para documentar un proyecto que no es de Python. Quiero distribuir ./doccarpetas en cada submódulo, que contienen submodule_name.rstarchivos para documentar ese módulo. Luego quiero absorber esos archivos en la jerarquía maestra para crear una especificación para todo el...
¿Cómo se formatea el texto dentro de un enlace indicado en reStructuredText? Específicamente, deseo generar el siguiente HTML a partir de mi primera: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation
La compilación de documentos de Sphinx en read-the-docs falla con el siguiente error (complete el registro a continuación): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index'
Descargue el archivo simple.7ze instálelo en su esfinge para reproducir los problemas que describí aquí, para reproducirlo, puede ejecutar: make clean make html descargue e instale en su esfinge para reproducir problemas Hay dos artículos en sample/source, el contenido es el mismo, la única...