From 18bf1b4a76dd41fa2d6f1dd122d247f0b8e5f24e Mon Sep 17 00:00:00 2001 From: msclock Date: Tue, 9 Jan 2024 08:48:56 +0800 Subject: [PATCH] docs: add CI integration sections Signed-off-by: msclock --- docs/getting_started.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/getting_started.md b/docs/getting_started.md index f7217b5..5fa4e80 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -34,3 +34,18 @@ sphinx_deployment_dll = { }, } ``` + +## CI Workflow + +### GitHub + +Refer to the +[GitHub Actions](https://github.com/msclock/sphinx-deployment/actions) workflow. +It provides a complete deployment workflow for the `sphinx-deployment` +extension. + +### GitLab + +The working template based on +[GitLab CI](https://docs.gitlab.com/ee/ci/quick_start/README.html) are available +[here](https://msclock.gitlab.io/gitlab-ci-templates/latest/docs/Sphinx/).