如何让Sphinx的autodoc省略模块名称?

时间:2014-02-23 22:22:09

标签: python python-sphinx

我无法控制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

这就是我想要的,除了生成的Scheduler类文档如下:

class Scheduler.Scheduler()
...[all the methods etc documented correctly]¶

我可以忍受这一点,但为了在别处交叉引用该类,我必须指的是

:class:`Scheduler.Scheduler`

导致可怕的笨拙文件。

如何说服autodoc从类文档中省略模块名称 - 我认为它必须是可能的,因为其他软件包文档似乎确实有它?

  • 查尔斯

1 个答案:

答案 0 :(得分:0)

我认为..currentmodule指令会帮助你。