2016-03-27 12 views
0

Wenn Sphinx-apidoc mit .rst Dateien zu erzeugen, wird die Ausgabe produziert keine Labels enthalten:Linking Paket über Sphinx-apidoc erzeugt

dessn.examples package 
====================== 

.. automodule:: dessn.examples 
    :members: 
    :undoc-members: 
    :show-inheritance: 

Subpackages 
----------- 

.. toctree:: 

    dessn.examples.discrete 
    dessn.examples.simple 

Was ich versuche zu bestimmten Seiten verlinken zu tun aus eine angepasste Homepage, die nicht mit apidoc generiert wird. Jedoch kann ich keine Möglichkeit finden, api-doc aufzurufen und sie selbst zu erzeugen, noch kann ich einen geeigneten Weg finden, einfach ohne eine Bezeichnung auf die richtige .rst zu verlinken, und ohne einfach die absolute HTML-Datei, die ich kenne, einzugeben wird erzeugen.

Ich kann die ::include-Anweisung verwenden, und es funktioniert gut, aber ich konnte vollständig eine Anweisung nicht finden, die einfach einen Hyperlink zu der ersten Datei generieren wird.

Fehle ich etwas offensichtlich hier, oder muss ich einen Weg finden, api-doc Insert-Etiketten zu machen? äquivalent ist für diese Frage

Prost

+1

Vielleicht ist der Code durch einfaches Einsetzen erreicht werden können Sie die Verwendung [ ': py: mod:'] (http: //www.sphinx- doc.org/en/stable/domains.html#cross-referencing-python-objects) Querverweisrolle. Siehe auch http://stackoverflow.com/a/22714510/407651. – mzjn

+0

Genau das wollte ich. Ich war so fest auf der Suche nach dem Wort Paket, dass das Wort Modul direkt über meinen Kopf ging. Vielen Dank! – Samreay

Antwort

0

Nach dem Thread, der die beste Lösung, so weit verbunden mzjn ist ein Paket und ein Modul zum ersten zu erkennen, und dass Sie die Modul Python Referenz, so detailliert verwenden können here on sphinx .

Als solche wird die Verbindung zum dessn.examples.simple Paket kann

:py:mod:`dessn.examples.simple`