python - links - sphinx tutorial español

¿Cómo puedo hacer una referencia cruzada de una función generada por autodoc en Sphinx?

Question

Estoy usando la función autodoc Sphinx para generar documentación basada en los documentos de mi biblioteca de Python.

La sintaxis para referencia cruzada se encuentra here

Una etiqueta debe preceder a la sección para permitir que se haga referencia a esa sección desde otras áreas de la documentación.

Lo que tengo es un archivo .rst (ReStructeredText) para una de mis clases. Usa

.. autoclass:: classname
    :members:

Para generar documentación para la clase.

Mi pregunta es, ¿cómo haría referencia a los métodos autogenerados de la clase desde otro primer documento en la documentación? Si trato de colocar una etiqueta dentro de la docstring del método, Sphinx se queja. Si trato de colocar una etiqueta antes del encabezado del método, Sphinx no lo reconoce.

¿Hay una forma simple de hacerlo, o tendré que escribir explícitamente en mi archivo de clase el nombre del método y precederlo con una etiqueta?

Aquí hay un ejemplo de una referencia dentro de [la documentación 2 Python haciendo lo que necesito (supongo que utilizó la función autodoc, aunque no estoy seguro)

Answer 1

No necesita agregar etiquetas. Para hacer referencia a una clase, método u otro objeto documentado de Python , utilice el marcado proporcionado por el dominio de Python .

Por ejemplo, lo siguiente define una referencia mymethod método mymethod :

:py:meth:`mymodule.MyClass.mymethod`

O incluso más simple (ya que el dominio de Python es el predeterminado):

:meth:`mymodule.MyClass.mymethod`

La documentación de 2 que se vincula en la pregunta incluye dos referencias cruzadas de este tipo (haga clic en "Mostrar origen" para ver el marcado reST).