🐛 FIX: Fix edge-case when page is '#'

[pablogsal]

When building on Read the Docs, the parameter
DOCUMENTATION_OPTIONS.URL_ROOT can return '#' and that returns an
incorrect path to the svg icon for the copy button.

Closes: #121

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

[pablogsal]

CC: @pradyunsg @choldgraf

If this is good with you, it would be great if we can get a release out of it :)

[choldgraf]

hmmm this doesn't seem quite right - the clipboards are missing in the readthedocs build. Can you confirm this works on your machine?

[pablogsal]

hmmm this doesn't seem quite right - the clipboards are missing in the readthedocs build. Can you confirm this works on your machine?

Ah, I just saw that the CI does a RTD build. Let me find out what's going on

[pablogsal]

@choldgraf I think this should be fixed by now

[choldgraf]

cool - and this is probably obvious but just to confirm since we don't explicitly test for it here: this patch fixes your problem with the root doc not working properly?

(can we think of a way to test that case? I don't think it's strictly necessary but would be good if it's easy)

[pablogsal]

cool - and this is probably obvious but just to confirm since we don't explicitly test for it here: this patch fixes your problem with the root doc not working properly?

Yup, I tested it here:

python/devguide#713

this is how it renders:

https://cpython-devguide--713.org.readthedocs.build/#

(can we think of a way to test that case? I don't think it's strictly necessary but would be good if it's easy)

I don't know what's the best way to test this. I have been checking the output of the RTD in the this repo CI when you click the root (as it adds the #).

[pradyunsg]

LGTM, although a non-blocking concern that we're doing one unnecessary round trip, that's similar to:

s = "string"
y = f"{s}"

[pradyunsg]

An easy way to test this in this PR and make future breakage less likely, would be to add a code block to the documentation root for this too!

[choldgraf]

@pradyunsg but there already is, isn't there? the landing page has code blocks in it. Am I missing something?

[pradyunsg]

Nope, I'm just a confused kiddo. :)

[welcome]

Congrats on your first merged pull request in this project! 🎉


Thank you for contributing, we are very proud of you! ❤️

[pablogsal]

Thanks a lot @choldgraf for the review and the quick release ❤️