Skip to content
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.

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

📝 Switch to furo theme for documentation #286

Merged
merged 5 commits into from
Jun 16, 2023
Merged

Conversation

burgholzer
Copy link
Member

@burgholzer burgholzer commented Jun 16, 2023

Description

This PR changes the default theme for the documentation to furo.
The main reason being that the sphinx-rtd-theme isn't well maintained and has led to multiple issues.
As a nice side effect, fury makes light and dark mode a breeze and makes code look nice in both cases without any manual css edits.

This PR also updates the RtD CI configuration to use newer Ubuntu runners and Python 3.11.

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
@burgholzer burgholzer added the documentation Improvements or additions to documentation label Jun 16, 2023
@burgholzer burgholzer self-assigned this Jun 16, 2023
@codecov
Copy link

codecov bot commented Jun 16, 2023

Codecov Report

Merging #286 (45181de) into main (681649a) will decrease coverage by 0.2%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            main    #286     +/-   ##
=======================================
- Coverage   96.2%   96.0%   -0.2%     
=======================================
  Files         34      34             
  Lines       1712    1713      +1     
  Branches     208     208             
=======================================
- Hits        1647    1645      -2     
- Misses        65      68      +3     
Flag Coverage Δ
cpp 95.6% <ø> (-0.3%) ⬇️
python 97.3% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mqt/qcec/verify.py 100.0% <ø> (ø)
mqt/qcec/verify_compilation_flow.py 100.0% <ø> (ø)

... and 2 files with indirect coverage changes

@burgholzer burgholzer merged commit e253c80 into main Jun 16, 2023
@burgholzer burgholzer deleted the fix-docs-build branch June 16, 2023 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant