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

fix readthedocs (RTD) public docsite, modernize some of the docs build/testing #1119

Merged
merged 19 commits into from Dec 30, 2023

Conversation

briantist
Copy link
Contributor

@briantist briantist commented Dec 30, 2023

Fixes #1061
Resolves #1053
Resolves #1076
Closes #1109

I got added to the RTD maintainers and was able to update several settings, like our defualt branch.
I've also enabled pull request builds, so we can see when a PR would break RTD (or in the case of this PR, fixes it), and maintainers can also view the generated documentation which is nice.

Fixing the build involved updating a lot of outdated requirements, so I also moved all the requirements into poetry as described in #1053 .

Along the way, updated the extremely our-of-date sphinx and sphinx-rtd-theme versions, so maybe the docs will even look a little nicer ✨.

The requirements upgrades needed some changes throughout other test code to remove some deprecated things.

I didn't go as far as trying to untangle our custom doctest thing and remove that, there's enough in this PR already and I want to get the public docsite fixed. That work will probably be part of or a pre-requisite for trying to move doctests into pytest, described a bit in #1105 .

@briantist briantist added bug documentation documentation updates and/or requests for expanded documentation patch Used as part of release-drafter's version-resolver configuration labels Dec 30, 2023
@briantist briantist self-assigned this Dec 30, 2023
Copy link

codecov bot commented Dec 30, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7db7de1) 87.12% compared to head (e0583c6) 87.12%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1119   +/-   ##
=======================================
  Coverage   87.12%   87.12%           
=======================================
  Files          64       64           
  Lines        3162     3162           
=======================================
  Hits         2755     2755           
  Misses        407      407           

@briantist briantist added misc Used as a release-drafter "category" maintenance General technical debt and removed bug labels Dec 30, 2023
@briantist briantist changed the title fix readthedocs (RTD) public docsite fix readthedocs (RTD) public docsite, modernize some of the docs build/testing Dec 30, 2023
@briantist briantist marked this pull request as ready for review December 30, 2023 20:59
@briantist briantist requested a review from a team as a code owner December 30, 2023 20:59
@briantist
Copy link
Contributor Author

All changes here only affect dev/tests,a nd the public docsite, no changes to the library.

@briantist briantist merged commit 27dad5b into hvac:main Dec 30, 2023
35 checks passed
@briantist briantist deleted the docs/fix-rtd branch December 30, 2023 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation updates and/or requests for expanded documentation maintenance General technical debt misc Used as a release-drafter "category" patch Used as part of release-drafter's version-resolver configuration
Projects
None yet
1 participant