From 13485e846581f4e415533352c80133f577a26920 Mon Sep 17 00:00:00 2001 From: Sergey Serebryakov Date: Tue, 25 Jul 2023 00:32:49 +0000 Subject: [PATCH] Respect \f symbol when generating web-based documentation pages. The click library uses the `\f` escape character to designate that the following text in docstrings should not be included into documentation. The `mkdocs-click` plugin does not support this. This commit fixes this. --- docs/requirements.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a74d1b6f..046684ff 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,9 @@ mkdocs>=1.0.4 + +# This slightly updated version respects Click's help feature to skip everything that comes after the \f symbol. +# mkdocs-click +mkdocs-click @ git+https://github.com/sergey-serebryakov/mkdocs-click@feature/respect-ff-escape-char + mkdocs-material>=4.4.0 -mkdocs-click pymdown-extensions>=7.1 -r ../mlcube/requirements.txt