From edea4b80700cb7b49c23d456c4a958121c7520c1 Mon Sep 17 00:00:00 2001 From: Megvii Engine Team Date: Wed, 21 Sep 2022 15:27:45 +0800 Subject: [PATCH] ci(docs): add document build ci logic GitOrigin-RevId: f9a9c43a2a790a34b94d79bdc594fc690cbdeca0 --- imperative/python/scripts/sphinx.sh | 33 ----------------------------- 1 file changed, 33 deletions(-) delete mode 100755 imperative/python/scripts/sphinx.sh diff --git a/imperative/python/scripts/sphinx.sh b/imperative/python/scripts/sphinx.sh deleted file mode 100755 index deeaa1ab3..000000000 --- a/imperative/python/scripts/sphinx.sh +++ /dev/null @@ -1,33 +0,0 @@ -#!/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 -- GitLab