[doc] [workflow] Update hello and matrix section of the docs and add a workflow to check doc builds #1157

rexwangcc · 2020-06-06T03:06:32Z

Related issue = #... (if any)

Minor updates to the docs so users know there's ti example command they could run.
Add a Github Action on PRs to make sure doc updates don't break the doc build.

archibate · 2020-06-06T03:45:25Z

Thank for adding the workflow, just a kind reminder: don't forget to test if paths is working, i.e. if I didn't update doc, it won't trigger doc CI.

rexwangcc · 2020-06-06T04:06:43Z

To prove the paths directive in the newly added workflow works:

5b77f86 and 8f5f4ea did not trigger the docs build since there were no changes to docs/. 9cee5be triggered the docs build checker workflows since it added changed to docs/.

archibate

LGTM + nits.

docs/hello.rst

docs/dev_install.rst

… misc.

docs/matrix.rst

docs/index.rst

docs/utilities.rst

Co-authored-by: 彭于斌 <1931127624@qq.com>

…ite.

rexwangcc added 7 commits June 5, 2020 22:51

[skip ci] Update docs.

e2adbe2

How do I know if the docs still build?

2c033e6

[skip ci] Update the action.

977bd7c

Fix the format.

fe4ab81

[skip ci] needs sphinx_rtd_theme?

a515d5e

[skip ci] Remove the external dependency.

ae64ee4

[skip ci] Fix again.

1760bba

rexwangcc added 5 commits June 5, 2020 23:51

Test updates to other dirs won't trigger docs build action.

7980268

[skip ci] Revert the changes to docs for testing.

5d13163

[skip ci] Test updates to other dirs won't trigger docs build action.

5b77f86

[skip ci] Revert the change for testing.

8f5f4ea

[skip ci] Bring back the updates to docs.

9cee5be

Fix a typo in workflow name.

acceb9a

rexwangcc marked this pull request as ready for review June 6, 2020 04:08

rexwangcc changed the title ~~[Doc] [misc] Minor updates to docs~~ [Doc] [misc] Update hello and matrix section of the docs and add a workflow to check doc builds Jun 6, 2020

archibate changed the title ~~[Doc] [misc] Update hello and matrix section of the docs and add a workflow to check doc builds~~ [doc] [workflow] Update hello and matrix section of the docs and add a workflow to check doc builds Jun 6, 2020

archibate self-requested a review June 6, 2020 08:01

archibate added the skip ci label Jun 6, 2020

archibate reviewed Jun 6, 2020

View reviewed changes

docs/hello.rst Outdated Show resolved Hide resolved

docs/dev_install.rst Outdated Show resolved Hide resolved

rexwangcc added 4 commits June 6, 2020 14:08

[skip ci] English.

73d39db

[skip ci] Revert the hello to avoid confusion.

a55cc36

[skip ci] Rename utilities to dev_ and add a new utilities section to…

65616dc

… misc.

[skip ci] Lint and format.

f024907