Title: Generate version selector dynamically via JavaScript by humitos · Pull Request #179 · python/docsbuild-scripts · GitHub
Open Graph Title: Generate version selector dynamically via JavaScript by humitos · Pull Request #179 · python/docsbuild-scripts
X Title: Generate version selector dynamically via JavaScript by humitos · Pull Request #179 · python/docsbuild-scripts
Description: Note this is just a proof of concept to start the conversation. While working on the idea to generate the version/language selectors and combine them with the data fetched from Read the Docs API, I realized that if we are migrating only one version to Read the Docs and using a proxy to serve it at the official docs.python.org domain, there is no need to use a different version/language selector at all --since all the URLs will be the same and all the JavaScript logic will be the same. The proxy will do the magic to redirect to Read the Docs only the versions configured in the proxy 1. However, since when building on Read the Docs the variables VERSIONS and LANGUAGES are not passed, we need to populate them dynamically with JavaScript when the page is served. ToDo Populate all_languages in the same way. Do we have a JSON file from where we can populate the LANGUAGES variable? Move this switchers.js file to https://github.com/python/cpython/tree/main/Doc/tools/static I'm opening a PR here to show what I'm thinking and discuss if this is the approach we want to follow. BTW, the code is not tested. I just wrote it as an example to show what I'm thinking is the direction. cc @hugovk Related: python/python-docs-theme#193 python/docs-community#5 Footnotes Once all the versions/languages are migrated to Read the Docs, we won't require the release-cycle.json nor other file to populate the LANGUAGES variable because this data will come from Read the Docs Addons API. ↩
Open Graph Description: Note this is just a proof of concept to start the conversation. While working on the idea to generate the version/language selectors and combine them with the data fetched from Read the Docs API, I...
X Description: Note this is just a proof of concept to start the conversation. While working on the idea to generate the version/language selectors and combine them with the data fetched from Read the Docs API, I...
Opengraph URL: https://github.com/python/docsbuild-scripts/pull/179
X: @github
Domain: patch-diff.githubusercontent.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:27c36281-eb9f-2f6d-77d4-9e5565996a22 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | E36E:330F09:402B50:59EB76:6970A7A4 |
| html-safe-nonce | c3dd9e7c3ec04f3997c709a2069bba5b3791095b97e3ab621ea80a4f9c65dd18 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFMzZFOjMzMEYwOTo0MDJCNTA6NTlFQjc2OjY5NzBBN0E0IiwidmlzaXRvcl9pZCI6IjU5MTc0Nzc5Nzc5NDIxNzM2MDQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 90edf51528a169d945d4a06cbfa14668cb53f1754e74037a8fa38e3ad99d0c98 |
| hovercard-subject-tag | pull_request:1983508795 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/docsbuild-scripts/pull/179/files |
| twitter:image | https://avatars.githubusercontent.com/u/244656?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/244656?s=400&v=4 |
| og:image:alt | Note this is just a proof of concept to start the conversation. While working on the idea to generate the version/language selectors and combine them with the data fetched from Read the Docs API, I... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | b06a4c45c45fd0bb038b3759265ea6e38211f45d18130bc65261990be6b5972a |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/python/docsbuild-scripts git https://github.com/python/docsbuild-scripts.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 23553472 |
| octolytics-dimension-repository_nwo | python/docsbuild-scripts |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 23553472 |
| octolytics-dimension-repository_network_root_nwo | python/docsbuild-scripts |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 0e1c4964831785bd64cb22d82e7cf2391ae01f45 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width