Skip to content

Remove github edit link in non-trunk versions of docs#596

Merged
adiroiban merged 2 commits intotwisted:trunkfrom
SmileyChris:docs-edit-link
May 6, 2024
Merged

Remove github edit link in non-trunk versions of docs#596
adiroiban merged 2 commits intotwisted:trunkfrom
SmileyChris:docs-edit-link

Conversation

@SmileyChris
Copy link
Contributor

@SmileyChris SmileyChris commented May 6, 2024

Description

In the sphinx configuration, remove github edit link in non-trunk versions of docs.

This only triggers specifically for read the docs, since it's based one of their custom environment variables.

Fixes #505

@SmileyChris SmileyChris requested a review from a team as a code owner May 6, 2024 21:28
Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks.

I can see that edit link is not enabled for the build on this PR https://towncrier--596.org.readthedocs.build/en/596/tutorial.html

Let's merge and see that the edit page is still enabled on https://towncrier.readthedocs.io/en/latest/tutorial.html

@adiroiban adiroiban merged commit 3427a19 into twisted:trunk May 6, 2024
@adiroiban
Copy link
Member

Hi Chris.

It looks like this does not work as expected.

We don't have the edit links for the "latest" version - https://towncrier.readthedocs.io/en/latest/tutorial.html

The edit link is present on "trunk" https://towncrier.readthedocs.io/en/trunk/tutorial.html

but I don't think that people are using the "trunk" url.


The defaul version is "stable" ...aka latest tag - https://towncrier.readthedocs.io/en/stable/


Note that on Read The Docs, we have 2 builds for each merge in trunk

https://readthedocs.org/projects/towncrier/builds/

The "trunk" build and the "latest" build.

@SmileyChris can you please send another PR that will also include "latest" in the list version with edit enabled ?

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

"Edit" link on readthedocs documentation pages links to http 404 page

2 participants