[GitHub] [dolphinscheduler] zhongjiajie commented on a change in pull request #8693: [Feature-8369][Document]Add docs building test instructions in pydolphinscheduler DEVELOP.md

[GitBox <gi...@apache.org>]

zhongjiajie commented on a change in pull request #8693:
URL: https://github.com/apache/dolphinscheduler/pull/8693#discussion_r819308233



##########
File path: dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
##########
@@ -83,6 +83,23 @@ black .
 flake8
 ```
 
+## Build Docs
+We use [sphinx][sphinx] to build docs. DS 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

Review comment:
       Same as the title, we should add a blank line between content and code

##########
File path: dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
##########
@@ -83,6 +83,23 @@ black .
 flake8
 ```
 
+## Build Docs
+We use [sphinx][sphinx] to build docs. DS Python API CI would automatically build docs when you submit pull request in 

Review comment:
       We should use keyword `Dolphinscheduler` instead of short `DS`
   
   ```suggestion
   We use [sphinx][sphinx] to build docs. Dolphinscheduler Python API CI would automatically build docs when you submit pull request in 
   ```

##########
File path: dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
##########
@@ -83,6 +83,23 @@ black .
 flake8
 ```
 
+## Build Docs
+We use [sphinx][sphinx] to build docs. DS 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

Review comment:
       Same as L98

##########
File path: dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
##########
@@ -83,6 +83,23 @@ black .
 flake8
 ```
 
+## Build Docs
+We use [sphinx][sphinx] to build docs. DS Python API CI would automatically build docs when you submit pull request in 

Review comment:
       Maybe we should add blank line between title and content.

##########
File path: dolphinscheduler-python/pydolphinscheduler/DEVELOP.md
##########
@@ -83,6 +83,23 @@ black .
 flake8
 ```
 
+## Build Docs
+We use [sphinx][sphinx] to build docs. DS 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 sphinx
+pip install sphinx_rtd_theme
+pip install sphinx_click 

Review comment:
       we have a shortcut in `setup.py`. which you could find in https://github.com/apache/dolphinscheduler/blob/dev/dolphinscheduler-python/pydolphinscheduler/setup.py#L175
   ```suggestion
   pip install .[doc]
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org