python-sphinx - the - sphinx python example
¿Cómo puedo vincular/hacer referencia a otro archivo reST en la documentación? (4)
Escribo el enlace a otro documento usando esto:
:doc:`my document <../my_doc>`
../my_doc es la ruta a mi archivo my_doc.rst .
También tengo la extensión inter-sphinx en mi archivo conf.py
extensions = [''sphinx.ext.intersphinx'']
Simplemente no tengo idea de cómo puedo enlazar a otro documento en el archivo reST.
Quiero vincular un archivo llamado install.rst a mi guía de inicio rápido en un párrafo. No sé cómo puedo lograr esto.
Por favor, ¿puede también referirse a un gran recurso desde el cual puedo buscar sintaxis para descansar? El inicio rápido predeterminado es un poco aburrido y no implica una discusión profunda sobre el uso del descanso con la esfinge.
El documento en cuestión es: http://todx.rtfd.io
Para crear enlaces entre diferentes archivos reStructuredText (.rst) puede usar el marcado en línea proporcionado por la esfinge. Consulte la documentación bajo el título Documentos de referencias cruzadas.
En la parte superior del archivo se define su etiqueta.
.. _my-reference-label:
A continuación, puede vincular a él desde otros documentos utilizando
:ref:`my-reference-label`.
No creo que necesites usar la extensión intersphinx, ya que es para enlaces entre diferentes proyectos. Con este método puede vincular diferentes archivos .rst utilizando sus rutas relativas como se describe en el enlace de documentación anterior.
Para referir otros archivos tuve que incluir lo siguiente en el conf.py Tomé el código de los documentos de Pillow (horquilla PIL) here .
extensions = [''sphinx.ext.intersphinx'']
Creo que la extensión entre la esfinge vino en mi ayuda. Se enlazó a través de las otras páginas de documentos.
Simplificando la respuesta de @ eme-eme, puedes simplemente hacer:
:doc:`path/to/document`
No es necesario que incluya la ruta en <> y que proporcione un texto para mostrar. En este caso, un encabezado de nivel superior del documento de referencia se mostrará como un enlace.
No necesitas una extensión entre la esfinge para eso.