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

Refactor sphinx config and bump docs python version #364

Merged
merged 3 commits into from
May 9, 2023

Conversation

sduquemesa
Copy link
Contributor

Context:
Sphinx doc builds were failing due to dependencies on deprecated or old package version when building the docs

Description of the Change:
This PR

  • refactors the .readthedocs.yml configuration file to set the container version of the readthedocs builder
  • bumps python version of the sphinx container to v3.10
  • unpins requirements in doc/requirements.txt to use the latest version available of packages

Benefits:
Docs build and hopefully will continue to do so as dependent packages get upgraded

Possible Drawbacks:
Doc requirements is now unpinned

Related GitHub Issues:
None

@sduquemesa sduquemesa requested a review from nquesada May 9, 2023 19:35
@sduquemesa sduquemesa changed the title Refactor sphinx config and bump python version Refactor sphinx config and bump docs python version May 9, 2023
@sduquemesa sduquemesa self-assigned this May 9, 2023
@sduquemesa sduquemesa added documentation dependencies Pull requests that update a dependency file labels May 9, 2023
@nquesada
Copy link
Collaborator

nquesada commented May 9, 2023

Thanks @sduquemesa !

@codecov
Copy link

codecov bot commented May 9, 2023

Codecov Report

Merging #364 (8cac798) into master (43757a9) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #364   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           27        27           
  Lines         1891      1891           
=========================================
  Hits          1891      1891           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 43757a9...8cac798. Read the comment docs.

@nquesada nquesada merged commit d1b4922 into master May 9, 2023
@nquesada nquesada deleted the refactor-sphinx-config branch May 9, 2023 20:16
nquesada added a commit that referenced this pull request May 31, 2023
* Refactor sphinx config and bump docs python version (#364)

* fix [.readthedocs.yml] - increase python version

Fixes urllib3 v2.0 not supporting versions <1.1.1 of openSSL. See readthedocs/readthedocs.org#10290.

* fix [.readthedocs.yml] - set container image and python version

* unpin doc requirements

* Update decompositions.py and readds the Takagi decomposition (#363)

* Update decompositions.py

* New takagi

* New takagi

* Passes black

* Simplifies blochmessiah

* Simplifies blochmessiah

* Found a case that breaks Takagi

* Fixes all the tests

* Fixes issues found by the linter

* Adds extra test

* Adds extra test

* dummy

* dummy

* fix [.readthedocs.yml] - increase python version

Fixes urllib3 v2.0 not supporting versions <1.1.1 of openSSL. See readthedocs/readthedocs.org#10290.

* fix [.readthedocs.yml] - set container image and python version

* unpin doc requirements

* Revert "fix [.readthedocs.yml] - increase python version"

This reverts commit db0e8d7.

---------

Co-authored-by: Nicolas Quesada <nquesada@pop-os.localdomain>
Co-authored-by: Sebastián Duque Mesa <675763+sduquemesa@users.noreply.github.com>

* Dummy commit

* Passes black

* linting

* Updates module summary

---------

Co-authored-by: Sebastián Duque Mesa <675763+sduquemesa@users.noreply.github.com>
Co-authored-by: Nicolas Quesada <nquesada@pop-os.localdomain>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants