这是我的项目结构:
base/devices.py
users/devices.py
company/devices.py
这是我的index.rst
:
.. My documentation master file.
Welcome to documentation!
=========================
.. toctree::
:maxdepth: 3
:caption: Contents:
users.rst
company.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
base/devices.txt
:
.. automodule:: base.devices
:noindex: # base docs may be included in several .rst files
:members:
users.rst
和company.rst
相似:
USERS
*****
Devices
=======
.. include:: base/devices.txt
.. automodule:: users.devices # in company.rst "company.devices"
:members:
在base/devices.py
中,我有一个函数check_devices()
在users/devices.py
中,我具有函数check_devices()
,但具有另一个文档字符串和另一个行为
当我在用户页面上生成文档时,我可以看到两个功能:base.devices.check_devices
和users.devices.check_devices
如何从用户页面中排除base.devices.check_devices
个文档字符串,而又不失去在多个rst文件中包含base/devices.txt
的可能性以及没有复制粘贴样式的可能性?