api文档的书写

写文档写要与写代码一样,增加复用。

比如 model 说明就只需要一个,api中含有哪些字段,就在api说明中增加到那些 models 的链接。

使用 sophinx

如何生成目录

.. toctree::
model

如何添加链接

# 标记
.. _client-model:
# 引用
:ref:`client-model字段说明 <client-model>`

效果

链接能够满足复用的需要,但是需要跳转。

能不能实现变量的效果?

声明 任务详情="任务详情",然后在其他地方引用这个变量,文档中就能显示对应内容。

原文地址:https://www.cnblogs.com/jay54520/p/6600671.html