Skip to content

doc: remove new versions from scylladb_markdown_recommonmark_versions #557

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

Open
annastuchlik opened this issue Jun 13, 2025 · 0 comments
Open
Assignees

Comments

@annastuchlik
Copy link

Problem

The scylladb_markdown_recommonmark_versions list in the conf.py file incorrectly includes all Java Driver versions.

To-do

Remove versions released after this commit (24 July 2024) in scylladb_markdown_recommonmark_versions so that they use the new Markdown parser.

Background

We introduced a new parser to replace the deprecated recommonmark parser. However, the old Java Driver versions still have to use it. For this reason, we added the scylladb_markdown_recommonmark_versions option to list the old versions that use the old parser.

  • Using the deprecated parser limits the functionality and prevents us from adding fixes. For example:docs: fix md redirections for multiversion support #531
  • For the above reason, the new versions that can use the new parser should NOT be listed under scylladb_markdown_recommonmark_versions.
  • This means that the scylladb_markdown_recommonmark_versions is stable and should not be updated when you release a new version.
  • A new version is configured using the BRANCHES parameter in the conf.py file in the section with the description: "Build documentation for the following tags and branches"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants