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.

Sign up for GitHub

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

Jump to bottom

Changes to conf.py in preparation for RTD Addons rollout #1070

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Changes to conf.py in preparation for RTD Addons rollout #1070

merged 1 commit into from
Jul 19, 2024

Conversation

swainn
Copy link
Member

@swainn swainn commented Jul 19, 2024

Description

Update conf.py per RTD's recommendations. See: https://about.readthedocs.com/blog/2024/07/addons-by-default/

Changes Made to Code:

  • Get html_baseurl from READTHEDOCS_CANONICAL_URL environment variable.
  • Add READTHEDOCS to the html_context.

Quality Checks

  • New code is 100% tested
  • Code has been formated
  • Code has been linted
  • Docstrings for new methods have been added

@swainn swainn self-assigned this Jul 19, 2024
@swainn swainn added the docs label Jul 19, 2024
@swainn swainn added this to the Version 4.3 milestone Jul 19, 2024
@coveralls
Copy link

Coverage Status

coverage: 99.936%. remained the same
when pulling c08853c on rtd-addons
into 77b621d on main.

@swainn swainn merged commit 1a761f2 into main Jul 19, 2024
42 checks passed
@swainn swainn deleted the rtd-addons branch July 19, 2024 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdc50 sdc50 Awaiting requested review from sdc50

@shawncrawley shawncrawley Awaiting requested review from shawncrawley

Assignees

@swainn swainn

Labels
docs
Projects
None yet
Milestone
Version 4.3
Development

Successfully merging this pull request may close these issues.
2 participants
@swainn @coveralls