Deploy docs to Github pages

[yann1cks]

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]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.54%. Comparing base (cfaa5db) to head (b39608c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #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]

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.