Project

General

Profile

Actions

Task #8118

open

docs: use dynamic suricata version mentions

Added by Juliana Fajardini Reichow about 1 month ago. Updated 14 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Target version:
Effort:
Difficulty:
Label:
Needs backport to 7.0, Needs backport to 8.0

Description

To avoid what we have with #8113, have the suricata versions mentioned in the docs be variables.

Decided whether via something like a variable ( %VERSION% ) or via Sphinx build-time method, or something else.


Related issues 1 (1 open0 closed)

Related to Suricata - Documentation #8113: doc: remove mention of suricata-7 in latest docsIn ReviewJuliana Fajardini ReichowActions
Actions #1

Updated by Juliana Fajardini Reichow about 1 month ago

Actions #2

Updated by Juliana Fajardini Reichow 14 days ago

will require more exploration. There are Sphinx directives that could work to check which version we're building, such as ifconfig (https://www.sphinx-doc.org/en/master/usage/extensions/ifconfig.html#directive-ifconfig) but the version to be replaced happens to be within a code-block, so we'd need an external extension for that, from what I could see (Found https://pypi.org/project/sphinx-substitution-extensions/, not sure yet if that would work on RtD).

Actions #3

Updated by Juliana Fajardini Reichow 14 days ago

Tried using this substitutions extension, but didn't manage to make it work, locally:

 WARNING: Pygments lexer name ':substitutions:' is not known [misc.highlighting_failure]

Will keep trying.

Actions

Also available in: Atom PDF