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

Make deindex-old-docs.js publicly accessible for Read the Docs deindexing #4621

Merged
merged 4 commits into from
Mar 28, 2025

Conversation

DimedS
Copy link
Member

@DimedS DimedS commented Mar 28, 2025

Description

This PR moves deindex-old-docs.js to the /docs/_static/ directory and updates the conf.py configuration to ensure the script is included in the built documentation output.

Read the Docs requires the script to be publicly accessible at a stable URL in order to deindex outdated documentation versions. Serving it from _static ensures it's available at:

https://docs.kedro.org/en/stable/_static/deindex-old-docs.js

Part of #3741

Signed-off-by: Dmitry Sorokin <[email protected]>
@DimedS DimedS linked an issue Mar 28, 2025 that may be closed by this pull request
@astrojuanlu
Copy link
Member

 sphinx.errors.SphinxWarning: html_static_path entry '_static' does not exist 

@DimedS DimedS force-pushed the docs/deindex-script-public branch from 3d3c8b8 to 470458a Compare March 28, 2025 15:07
Signed-off-by: Dmitry Sorokin <[email protected]>
@astrojuanlu
Copy link
Member

We are expecting the file to be found at

https://kedro--4621.org.readthedocs.build/en/4621/_static/deindex-old-docs.js

Signed-off-by: Dmitry Sorokin <[email protected]>
@DimedS
Copy link
Member Author

DimedS commented Mar 28, 2025

We are expecting the file to be found at

https://kedro--4621.org.readthedocs.build/en/4621/_static/deindex-old-docs.js

great, it's in place

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

LGTM!

@DimedS DimedS requested a review from jitu5 March 28, 2025 16:12
@DimedS DimedS merged commit f9dbfc4 into main Mar 28, 2025
10 checks passed
@DimedS DimedS deleted the docs/deindex-script-public branch March 28, 2025 16:20
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.

Improve SEO and maintenance of documentation versions
3 participants