Skip to content

Commit

Permalink
✨ 优化链接索引
Browse files Browse the repository at this point in the history
  • Loading branch information
snowykami committed Aug 31, 2024
1 parent f023f3c commit 5a33d81
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- i18n多语言支持
- 可选注释风格
- 可选主题支持
- 支持对象带有相对链接跳转

## 安装

Expand Down Expand Up @@ -48,6 +49,7 @@ litedoc <your_module_path> -o|--output <output_path>
- 可在文件头部使用`"""`包裹的注释写上文件的说明,会被自动放到文档的顶部
- 请不要在注释中使用特殊字符例如换行符`\n`,如有请使用`\\n`转义或使用原始字符串`r"""string content"""`,否则会导致解析错误
- 可以在注释中编写一些你所使用的文档框架支持的markdown增强语法,如表格,容器等,可增强用户阅读体验
- 可在参数注释中使用markdown的链接语法和哈希路由,如```p ([`Point3`](./point#class-point3))```: 点,以支持跳转到其他文档的链接
- 生成器默认不处理"私有"变量和函数,即以`_`开头的变量和函数(尽管Python没有真正的私有变量),也默认不处理没有注释的变量
- 如果你不想展示某个函数和变量,可以在函数文档字串任意处加上`@litedoc-hide`
- 变量注释支持在同一行内使用`#`添加的注释,也支持在下一行使用`"""注释内容"""`添加的注释
Expand Down

0 comments on commit 5a33d81

Please sign in to comment.