文章 2024-07-13 来自:开发者社区

Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。

Sphinx简介 Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。Sphinx特别适用于生成API文档,因为它能够自动从Python的docstrings中提取信息。 Sphinx基本使用 安装Sphin...

文章 2023-05-26 来自:开发者社区

快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释

背景 作为文档工具人,经常需要把代码里面的注释转换成语义化的 Markdown 文档,有时也需要进行反向操作。以前是写正则表达式全局匹配,时间长了这种方式也变得繁琐乏味。所以写了脚本来互转,增加一些便捷性。 解决方案 注释转 Markdown 下载地址:https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.2.0 操作步骤: ...

快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释

本页面内关键词为智能算法引擎基于机器学习所生成,如有任何问题,可在页面下方点击"联系我们"与我们沟通。