Skip to content

Deploy docs to Github pages#449

Merged
raphaelvallat merged 9 commits intoraphaelvallat:release_v060from
yann1cks:main
Feb 23, 2026
Merged

Deploy docs to Github pages#449
raphaelvallat merged 9 commits intoraphaelvallat:release_v060from
yann1cks:main

Conversation

@yann1cks
Copy link
Contributor

@yann1cks yann1cks commented Nov 2, 2024

Hello Raphael,

I created a Github Action to deploy the Docs to Github pages. It does not use an additional docs branch. This PR is more of a draft/example which deploys the docs to my custom domain (https://pingouin.stadtfeld.xyz/).

The following changes are needed on your site to deploy the docs to Github Pages:

  1. Verify your domain to protect it. Here is the official guide.
  2. Change the domain in the CNAME file to pingouin-stats.org. There is nothing else in this file.
  3. Configure your DNS following the official guide, Link.
  4. Also configure the www subdomain by adding the required CNAME record.

Deploying the documentation is triggered manually, because of on: workflow_dispatch in the documentation.yml file. There are many other triggers. Its possible to trigger the action if a specific tag is used or a release created. I do not know what you prefer, so I went with the manual option.

@codecov
Copy link

codecov bot commented Nov 2, 2024

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.54%. Comparing base (cfaa5db) to head (b39608c).
⚠️ Report is 11 commits behind head on release_v060.

Additional details and impacted files
@@              Coverage Diff              @@
##           release_v060     #449   +/-   ##
=============================================
  Coverage         98.54%   98.54%           
=============================================
  Files                19       19           
  Lines              3362     3362           
  Branches            493      493           
=============================================
  Hits               3313     3313           
  Misses               26       26           
  Partials             23       23           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@raphaelvallat raphaelvallat self-requested a review November 14, 2024 17:22
@raphaelvallat raphaelvallat added the docs/testing 📖 Documentation and unit testing label Nov 14, 2024
@raphaelvallat
Copy link
Owner

Hi @yann1cks,

Thank you so much for working on this and the detailed explanation on how to use this. This is great. I'll give it a try soon.

@raphaelvallat raphaelvallat self-assigned this Jan 6, 2026
@raphaelvallat raphaelvallat changed the base branch from main to release_v060 February 23, 2026 08:09
@raphaelvallat raphaelvallat force-pushed the main branch 4 times, most recently from 7884bf7 to b39608c Compare February 23, 2026 08:12
@raphaelvallat raphaelvallat merged commit cfa5561 into raphaelvallat:release_v060 Feb 23, 2026
1 check passed
raphaelvallat added a commit that referenced this pull request Feb 23, 2026
* Fix badge

* Add changelog for 0.6.0

* Update version

* Update codecov-action

* Fix coverage

* fix bold test in changelog

* Re-run notebooks

* Deploy docs to Github pages (#449)

* gh-pages documentation

* rename deploy job

* fix 404 page

* fix 404 again

* Update CNAME and ruff

* Update deploy_doc workflow

* remove CNAME (not required for GH)

---------

Co-authored-by: Raphael Vallat <[email protected]>

---------

Co-authored-by: Yannick <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs/testing 📖 Documentation and unit testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants