如何解决如何仅记录Sphinx中的部分功能?
使用Sphinx,我需要为我的Python应用生成两组文档:
我想在函数文档字符串中使用一个“标记”,以指示是否在第二组文档中包含该函数。
借助.. only
,我可以根据我提供给sphinx-build的-t <tagname>
来控制包含文档字符串的哪一部分。但是我找不到基于这些函数的文档字符串条目来过滤掉要包含在文档范围内的一组函数的任何方法。
解决方法
通常会发生-在发布问题后,您会得出答案。
设法使用https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#skipping-members并将以下代码放入 {
"Name": "AI Brain","Properties": {
"qty": 15,"price": 1
}
},{
"Name": "Air Conditioner","Properties": {
"qty": 190,"price": 1
}
}
// Root myDeserializedClass = JsonConvert.DeserializeObject<Root>(myJsonResponse);
public class Properties {
public int qty { get; set; }
public int price { get; set; }
}
public class Root {
public string Name { get; set; }
public Properties Properties { get; set; }
}
因此,如果我将// Root myDeserializedClass = JsonConvert.DeserializeObject<Root>(myJsonResponse);
public class AIBrain {
public int qty { get; set; }
public int price { get; set; }
}
public class AirConditioner {
public int qty { get; set; }
public int price { get; set; }
}
public class Root {
public AIBrain AIBrain { get; set; }
public AirConditioner AirConditioner { get; set; }
}
之类的东西用作任何函数的文档字符串的一部分-这表示每当我运行conf.py
时,仅此函数将保留在生成的文档范围内。 / p>
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。