Skip to content

Commit

Permalink
Respect \f symbol when generating web-based documentation pages.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
sergey-serebryakov committed Jul 25, 2023
1 parent daccf94 commit 13485e8
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 13485e8

Please sign in to comment.