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

BREAKING CHANGE: Use project API endpoint to get details #43

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

edgarrmondragon
Copy link

@edgarrmondragon edgarrmondragon commented Aug 14, 2024

Closes #42


📚 Documentation preview 📚: https://readthedocs-preview--43.org.readthedocs.build/en/43/

Comment on lines +31 to 37
if (project.versioning_scheme === "single_version_without_translations") {
RTD_URL = RTD_PROJECT_DOMAIN;
} else {
RTD_URL = RTD_PROJECT_DOMAIN + `${RTD_PROJECT_LANGUAGE}/${PR_NUMBER}/`;
} else if (project.versioning_scheme === "multiple_versions_with_translations") {
RTD_URL = RTD_PROJECT_DOMAIN + `${project.language.code}/${PR_NUMBER}/`;
} else if (project.versioning_scheme === "multiple_versions_without_translations") {
RTD_URL = RTD_PROJECT_DOMAIN + `${PR_NUMBER}/`;
}
Copy link
Member

Choose a reason for hiding this comment

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

You can remove all this block here and use directly urls.documentation that will always point to the correct URL no matter what's the configuration of the project.

Copy link
Author

Choose a reason for hiding this comment

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

That URL doesn't seem to point to the preview, though. Also, #42 (comment) gives me pause to making this change and suggests we should deprecate single-version in favor of versioning-scheme, for example.

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.

Support the "Multiple versions without translations (/<version>/<filename>)" versioning scheme
2 participants