This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new 4c1578a [Feature-8369][Document]Add docs building test instructions
in pydolphinscheduler DEVELOP.md (#8369) (#8693)
4c1578a is described below
commit 4c1578a374772310383ad2c08647e4ff94ffa81d
Author: Eric Gao <[email protected]>
AuthorDate: Tue Mar 29 10:56:53 2022 +0800
[Feature-8369][Document]Add docs building test instructions in
pydolphinscheduler DEVELOP.md (#8369) (#8693)
---
.../pydolphinscheduler/DEVELOP.md | 24 ++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
b/dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
index a0dbb41..beb95ad 100644
--- a/dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
+++ b/dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
@@ -146,6 +146,29 @@ python -m flake8
#### Testing
+## Build Docs
+
+We use [sphinx][sphinx] to build docs. Dolphinscheduler Python API CI would
automatically build docs when you submit pull request in
+GitHub. You may locally ensure docs could be built suceessfully in case the
failure blocks CI.
+
+To build docs locally, install sphinx and related python modules first via:
+
+```shell
+pip install '.[doc]'
+```
+
+Then
+
+```shell
+cd pydolphinscheduler/docs/
+make clean && make html
+```
+
+## Testing
+
+pydolphinscheduler using [pytest][pytest] to test our codebase. GitHub Action
will run our test when you create
+pull request or commit to dev branch, with python version `3.6|3.7|3.8|3.9`
and operating system `linux|macOS|windows`.
+
pydolphinscheduler using [pytest][pytest] to run all tests in directory
`tests`. You could run tests by the commands
```shell
@@ -209,3 +232,4 @@ users who may use it in other way.
[black-editor]:
https://black.readthedocs.io/en/stable/integrations/editors.html#pycharm-intellij-idea
[coverage]: https://coverage.readthedocs.io/en/stable/
[isort]: https://pycqa.github.io/isort/index.html
+[sphinx]: https://www.sphinx-doc.org/en/master/
