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

docs: Enable version switcher for the site. #381

Merged
merged 4 commits into from
May 3, 2024

Conversation

kirkrodrigues
Copy link
Member

Description

The docs theme we're using (pydata-sphinx-theme) supports a version-switcher. To enable the switcher, we need the valid/published versions for a project to be stored in a statically-hosted file. y-scope/yscope-docs#10 adds the versions file for this project.

This PR enables the version switcher.

Validation performed

See the validation steps in y-scope/yscope-docs#10

@kirkrodrigues kirkrodrigues changed the title Docs version switcher docs: Enable version switcher for the site. May 3, 2024
Copy link
Member

@junhaoliao junhaoliao left a comment

Choose a reason for hiding this comment

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

Tested with task docs:serve (listens at localhost) and CORS disabled in the browser (because the json file is hosted at domain docs.yscope.com).

We don't seem to have released any docs for v0.1.0 though. Is that a placeholder value? I assume the clp-versions.json file will be auto-generated by some script in https://github.com/y-scope/yscope-docs , right?

{
    "message": "Route GET:/clp/v0.1.0/ not found",
    "error": "Not Found",
    "statusCode": 404
}

@kirkrodrigues
Copy link
Member Author

kirkrodrigues commented May 3, 2024

Tested with task docs:serve (listens at localhost) and CORS disabled in the browser (because the json file is hosted at domain docs.yscope.com).

Right, y-scope/yscope-docs#10 adds CORS headers for localhost.

We don't seem to have released any docs for v0.1.0 though. Is that a placeholder value? I assume the clp-versions.json file will be auto-generated by some script in https://github.com/y-scope/yscope-docs , right?

Whoops, was just using that for testing. y-scope/yscope-docs#10 adds the real clp-versions.json file to the yscope-docs site.

@kirkrodrigues kirkrodrigues merged commit c73773b into y-scope:main May 3, 2024
1 check passed
@kirkrodrigues kirkrodrigues deleted the docs-version-switcher branch May 3, 2024 19:48
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.

2 participants