Tag: PYTHON-SPHINX
Quiero proporcionar un enlace a un archivo en mi proyecto, pero quiero que este enlace sea legible para personas y permanente. Haciendo esto: Enlace al archivo de referencia :download:myfile.json <../myproject/myfile.json>. Genera un enlace que se ve así: …../myproject/docs/_build/html/_downloads/b4c73f3851c188db23a20daeed2c/myfile.json ¿Tengo control sobre esto? Quiero que el enlace sea solo esto: …../myproject/docs/_build/html/_downloads/myfile.json . . . Read more
Estamos escribiendo una documentación de Sphinx con mi equipo a partir de páginas markdown usando myst-parser (https://myst-parser.readthedocs.io/en/latest/index.html), lo cual está funcionando bastante bien. Para evitar redundancias y mejorar el mantenimiento, nos gustaría compartir contenido entre diversas secciones de nuestra documentación de 2 maneras: 1) Listando la misma página única en . . . Read more
Estoy intentando construir un PDF a partir de documentos RST. En este caso, el documento index.rst no está vacío: # Cómo construir # La construcción bla bla bla .. toctree :: : hidden: file1 file2 file3 ¡En la salida PDF, el texto “La construcción bla bla bla” aparece sin ningún . . . Read more
Estoy enfrentando el mismo problema discutido en esta pregunta: El tema Furo Sphinx mayúscula demasiado en la documentación de la API. Sin embargo, la solución aceptada no funcionó, parece que la plantilla Furo está sobrescribiendo de alguna manera la custom.css: Agradezco cualquier ayuda para implementar esta simple personalización en el . . . Read more
Estoy teniendo problemas con Sphinx y autosummary. Aparentemente, Sphinx no puede documentar los atributos de instancia heredados. Por alguna razón, el error resultante es un error de importación. Código en Python: class Base: “””Clase Base.””” def __init__(self, **kwargs): “””Inicialización.””” self.model = None “””Un atributo.””” class Child(Base): “””Clase Hija.””” def __init__(self, . . . Read more