Come faccio a riferimento incrociato una funzione generato da autodoc nella Sfinge?

Sto usando la Sfinge autodoc funzione per generare la documentazione basata su le docstring della mia libreria Python.

La sintassi per il cross di riferimento è trovato qui

Un etichetta deve precedere la sezione in modo da consentire che la sezione a cui fa da altre aree della documentazione.

Quello che ho è un .prima (ReStructeredText) file per uno dei miei corsi. Utilizza

.. autoclass:: classname
    :members:

Per generare la documentazione per la classe.

La mia domanda è, come faccio a riferimento l’auto-generato metodi della classe da un’altra .primo documento nella documentazione? Se provo a inserire un’etichetta all’interno del metodo docstring, la Sfinge si lamenta. Se provo a inserire un’etichetta prima il metodo di denominazione, la Sfinge non lo riconosce.

C’è un modo semplice per fare questo, o devo scrivere in modo esplicito nel mio file di classe il nome del metodo e precedere con un etichetta?

Qui è un esempio di un riferimento all’interno della documentazione di PythonDue fare ciò di cui ho bisogno (sto assumendo il autodoc funzione, anche se non so per certo)

  • Il titolo chiede di funzioni, eppure il corpo e risposta sui metodi. Speravo ci sarebbe una risposta per il riferimento a un .. autofunction:: ma ahimè non è qui.
InformationsquelleAutor Matthew Stamy | 2014-03-27



One Reply
  1. 49

    Non c’è bisogno di aggiungere etichette. Per fare riferimento a una classe in Python, il metodo o l’altro documentato oggetto, utilizzare il codice fornito dal Python dominio.

    Per esempio seguente definisce un riferimento incrociato al mymethod metodo:

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

    O, ancora più semplice (visto che il Python di dominio è l’impostazione predefinita):

    :meth:`mymodule.MyClass.mymethod`

    La documentazione di TextWrapper.avvolgere che ci si collega in questione comprende due riferimenti di questo tipo (fare clic su “Visualizza Sorgente” per vedere il resto di markup).

    • E :mod:… per i moduli.
    • E :func:… per le funzioni. Un elenco completo di come cross-riferimento di Python ruoli è qui.

Lascia un commento