1
我無法控制Sphinx的autodoc功能。如何讓Sphinx的autodoc忽略模塊名稱?
我的目錄結構是:
projname
+ projname
__init__.py
Scheduler.py containing class Scheduler
+ docs
conf.py
index.rst
conf.py包含:
sys.path.insert(0, os.path.abspath('../projname'))
而且index.rst包含:
.. automodule:: Scheduler
此我想要做什麼,除了生成的調度程序類文檔出現爲:
class Scheduler.Scheduler()
...[all the methods etc documented correctly]¶
我能忍受的,但爲了相互參照,類別處,我不得不提及是
:class:`Scheduler.Scheduler`
導致可怕的笨拙文檔。
如何說服autodoc從類文檔中省略模塊名稱 - 我認爲它必須是可能的,因爲其他軟件包文檔似乎具有它?
- 查爾斯
找到了答案獅身人面像谷歌組郵件列表[我希望谷歌將搜索自己的羣體?] 對於引用我可以使用語法: :類:'.Scheduler' 的HTML沒有按」沒有領先的'。',並正確放入鏈接。這也適用於meth和attr鏈接。 – CharlesW