Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
MegEngine 天元
MegEngine
提交
7e2d8912
MegEngine
项目概览
MegEngine 天元
/
MegEngine
1 年多 前同步成功
通知
403
Star
4705
Fork
582
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
MegEngine
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
7e2d8912
编写于
11月 05, 2021
作者:
M
Megvii Engine Team
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
ci(docstring): add sphinx autodoc build test for docstring
GitOrigin-RevId: d6a4fd469a3c5759ab196a467485f9bc916393cd
上级
ead611e1
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
33 addition
and
0 deletion
+33
-0
imperative/python/scripts/sphinx.sh
imperative/python/scripts/sphinx.sh
+33
-0
未找到文件。
imperative/python/scripts/sphinx.sh
0 → 100755
浏览文件 @
7e2d8912
#!/bin/bash
set
-e
# This script can be used to find WARNINGs and ERRORs hide in Python docstring.
#
# * Usually we use Sphinx (https://www.sphinx-doc.org/) and its' tools
# to build HTML documentation for Python projects, such as MegEngine.
#
# * It simulates the process of automatically extracting docstrings from source code
# and try generating HTML pages, just like what MegEngine documentation will do.
#
# Install required Python dependence with pip then you will get following tools:
#
# * sphinx-apidoc: a tool for automatic generation of Sphinx sources that,
# using the autodoc extension, document a whole package in the style of
# other automatic API documentation tools. For more details:
# https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html
#
# * sphinx-build: generates documentation frome specific files. For more details:
# https://www.sphinx-doc.org/en/master/man/sphinx-build.html
#
# [NOTE]: You need build MegEngine first (target: develop) then run this script.
DOC_PATH
=
`
mktemp
-d
`
trap
'rm -rf "$DOC_PATH"'
EXIT
cd
$(
dirname
$0
)
/..
python3
-m
pip
install
-r
requires.txt
python3
-m
pip
install
-r
requires-sphinx.txt
sphinx-apidoc
-f
-F
-e
-o
$DOC_PATH
/source megengine
"megengine/core/ops/builtin/*"
PYTHONPATH
=
.
sphinx-build
-j
auto
-c
.
-W
--keep-going
\
$DOC_PATH
/source
$DOC_PATH
/build
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录