Study notes

.github/workflows/documentation-ci-cd.yml → .github/workflows/ci-cd.yaml

@@ -1,18 +1,18 @@
-# Copyright Jiaqi Liu
+# Copyright 2025 Jiaqi Liu. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
 ---
-name: Documentation CI/CD
+name: CI/CD
 
 "on":
   pull_request:
@@ -25,7 +25,7 @@ env:
   EMAIL: jack20220723@gmail.com
 
 jobs:
-  release:
+  documentation:
     name: Test & Release Documentation
     runs-on: ubuntu-latest
     steps:
@@ -35,16 +35,17 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7"
+          python-version: "3.10"
       - name: Install dependencies
         run: pip install -r requirements.txt -r doc/requirements.txt
       - name: Build documentation
         run: sphinx-build -b html doc/source doc/build/html
       - name: Deploy documentation to GitHub Pages
-        if: github.ref == 'refs/heads/master'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: doc/build/html
+          enable_jekyll: false
           user_name: ${{ env.USER }}
           user_email: ${{ env.EMAIL }}
+          cname: openstack-swift-python.qubitpi.org

doc/source/conf.py

@@ -27,8 +27,6 @@
 
 # -- General configuration ----------------------------------------------------
 
-html_baseurl = '/openstack-python-swiftclient/'
-
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc',