Skip to content

doc: remove new versions from scylladb_markdown_recommonmark_versions #557

Open
@annastuchlik

Description

@annastuchlik

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"

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions