Skip to content

Adapt to RTD Addons #4386

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
Merged
Bibo-Joshi merged 1 commit into from
Jul 21, 2024
Merged

Adapt to RTD Addons #4386

Bibo-Joshi merged 1 commit into from
Jul 21, 2024

Conversation

@Bibo-Joshi
Copy link
Member

@Bibo-Joshi Bibo-Joshi commented Jul 17, 2024 •
edited
Loading

I received a mail from RT pointing to https://about.readthedocs.com/blog/2024/07/addons-by-default/ and explaining that ptb currenlty relies on html_baseurl and that it should be set via

import os

# Set canonical URL from the Read the Docs Domain
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get("READTHEDOCS", "") == "True":
    html_context["READTHEDOCS"] = True

This is also explained somewhat in the current docs

Additional changes may be needed to adapt to RTD addons - in particular they include a native search as you type addon. I'll create a spearate issue for that and link to the furo theme issue tracking the topic.

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label Jul 17, 2024
@Bibo-Joshi Bibo-Joshi mentioned this pull request Jul 17, 2024
Open
@Bibo-Joshi
Copy link
Member Author

Bibo-Joshi commented Jul 17, 2024

Test build is up at https://docs.python-telegram-bot.org/en/docs-rtd-addons/index.html and looks successful. All links correctly link back to docs.ptb.org

@Bibo-Joshi Bibo-Joshi merged commit c3f17bb into master Jul 21, 2024
@Bibo-Joshi Bibo-Joshi deleted the docs-rtd-addons branch July 21, 2024 19:12
@github-actions github-actions bot locked and limited conversation to collaborators Jul 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Bibo-Joshi