Skip to content

Added RTD setup files#21

Merged
atteggiani merged 3 commits intomainfrom
davide/setup_rtd
Dec 23, 2025
Merged

Added RTD setup files#21
atteggiani merged 3 commits intomainfrom
davide/setup_rtd

Conversation

@atteggiani
Copy link
Collaborator

@atteggiani atteggiani commented Nov 27, 2025

  • Added RTD config
  • Added link-checking
  • Updated ci.yml to prevent it from running when only files related to documentation are changed

My admin permissions can be revoked now (please leave write permissions).

Note:
The current failure of the link-checker is due to the main branch not containing the documentation folder yet.

@atteggiani atteggiani self-assigned this Nov 27, 2025
@codecov
Copy link

codecov bot commented Nov 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.98%. Comparing base (0f47ae9) to head (7508889).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #21   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files           5        5           
  Lines         224      224           
  Branches       34       34           
=======================================
  Hits          215      215           
  Misses          3        3           
  Partials        6        6           

☔ 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.

@atteggiani atteggiani force-pushed the davide/setup_rtd branch 2 times, most recently from 4273e03 to d55b188 Compare November 27, 2025 05:44
Copy link
Collaborator

@dougiesquire dougiesquire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thanks @atteggiani

@atteggiani
Copy link
Collaborator Author

I'm thinking this comment applies to this repo as well.

What do you think?

@dougiesquire
Copy link
Collaborator

I'm thinking this comment applies to this repo as well.

What do you think?

Does it? I don't think there's any existing docs in this repo so it's not currently deploying to Github pages right?

@atteggiani
Copy link
Collaborator Author

I'm thinking this comment applies to this repo as well.
What do you think?

Does it? I don't think there's any existing docs in this repo so it's not currently deploying to Github pages right?

Oops you're right! No problems for this repo then!
I'll go on and merge. The link-checker fails due to the new page added (similar to another case you asked me about some days ago) and can be disregarded.

@atteggiani atteggiani merged commit 9b6719d into main Dec 23, 2025
12 of 13 checks passed
@atteggiani atteggiani deleted the davide/setup_rtd branch December 23, 2025 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants