Skip to content

Commit

Permalink
🔧 chore(sphinx_docs.yml): update Sphinx installation step to also ins…
Browse files Browse the repository at this point in the history
…tall sphinx_rtd_theme for better documentation styling

🔍 test(sphinx_docs.yml): add step to list files in _build directory to verify successful build
🚀 feat(sphinx_docs.yml): update deployment step to use GITHUB_TOKEN secret instead of REPO_TOKEN for better security
  • Loading branch information
skullzarmy committed Oct 24, 2023
1 parent d041ef7 commit 3570998
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions .github/workflows/sphinx_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,19 @@ jobs:
with:
python-version: "3.x"

- name: Install Sphinx
run: pip install Sphinx
- name: Install Sphinx and Theme
run: |
pip install Sphinx
pip install sphinx_rtd_theme
- name: Build Docs
run: |
cd docs
make html
- name: List files in _build
run: ls -R ./docs/_build/html

- name: Check Symlinks
run: find ./docs/_build/html -type l

Expand All @@ -51,5 +56,5 @@ jobs:
id: deployment
uses: actions/deploy-pages@v2
with:
token: ${{ secrets.REPO_TOKEN }}
token: ${{ secrets.GITHUB_TOKEN }}
artifact_name: github-pages

0 comments on commit 3570998

Please sign in to comment.