我想使用Sphinx为我的应用程序生成doc。 我的目标是在代码中为不同的受众撰写评论,然后根据目标受众生成文档。
换句话说,我想在我的代码中直接使用.. only::
之类的东西。
例如:
def myFunction(self):
""" myFunction general description
.. only:: dev
Some specififc infos for dev
.. only:: user
Some specific infos for user
:returns:
Description of return of myFunction
"""
然后致电:
sphinx-build.exe -t dev -b html source buildDev
OR
sphinx-build.exe -t user -b html source buildUser
我将获得该文档的两个版本。
我不知道我是否足够清楚。 会不可能?