Compresa la fonte nella documentazione di Sphinx - python, python-sphinx

Sto cercando di usare Sphinx per documentare un Pythonmio progetto, ma sto lottando con le differenze tra questo strumento e i soliti strumenti come JavaDoc che hanno lo scopo di documentare un'API. Ovviamente vedo che Sphinx ha molti più usi che documentare un'API, ma sembra che manchi del compito più semplice.

io sono riusciti per scoprire come far conoscere a Sphinx la struttura del tuo pacchetto, in modo da non doverlo replicare manualmente in file ReST. Il mio prossimo problema è:

È possibile includere un link alla sorgente per tutte le classi con Sphinx?

Ovviamente la fonte dovrebbe essere ben formattata, ma dal momento che la Sfinge usa i picchi, non penso che sia un problema.

risposte:

Dare un'occhiata a http://sphinx.pocoo.org/latest/ext/viewcode.html.

Includi un'estensione in conf.py.

extensions = ["sphinx.ext.viewcode"]