Skip to content

Enable Doxygen documentation deployment to GitHub Pages #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RhysU merged 1 commit into from
Jan 12, 2026
Merged

Enable Doxygen documentation deployment to GitHub Pages #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 30 additions & 32 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,31 +55,30 @@ jobs:
command: |
make stress

# Uncomment to enable automatic Doxygen documentation deployment to GitHub Pages
# deploy-docs:
# docker:
# - image: cimg/base:stable
# resource_class: small
# steps:
# - checkout
# - run:
# name: Install Doxygen and Graphviz
# command: |
# sudo apt-get update -qq
# sudo apt-get install -y doxygen graphviz
# - run:
# name: Build Doxygen documentation
# command: |
# doxygen Doxyfile
# - run:
# name: Deploy to gh-pages
# command: |
# if [ "${CIRCLE_BRANCH}" = "master" ]; then
# echo "Deploying documentation to gh-pages..."
# ./.circleci/deploy-ghpages.sh docs/html
# else
# echo "Not on master branch (current: ${CIRCLE_BRANCH}), skipping deployment"
# fi
deploy-docs:
docker:
- image: cimg/base:stable
resource_class: small
steps:
- checkout
- run:
name: Install Doxygen and Graphviz
command: |
sudo apt-get update -qq
sudo apt-get install -y doxygen graphviz
- run:
name: Build Doxygen documentation
command: |
doxygen Doxyfile
- run:
name: Deploy to gh-pages
command: |
if [ "${CIRCLE_BRANCH}" = "master" ]; then
echo "Deploying documentation to gh-pages..."
./.circleci/deploy-ghpages.sh docs/html
else
echo "Not master (current: ${CIRCLE_BRANCH}), skipping deployment"
fi

workflows:
matrix-tests:
Expand All @@ -96,10 +95,9 @@ workflows:
prereq-numpy:
- "numpy<2"
- "numpy<3"
# Uncomment to enable documentation deployment (also uncomment deploy-docs job above)
# - deploy-docs:
# requires:
# - test
# filters:
# branches:
# only: master
- deploy-docs:
requires:
- test
filters:
branches:
only: master