Skip to content

Commit b2be853

Browse files
committed
Warning note to pin MkDocs requirements
1 parent fdc3927 commit b2be853

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/builds.rst

+6
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ and MkDocs will build the ``.md`` files in that directory.
5656
As MkDocs doesn't support automatic PDF generation,
5757
Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option.
5858

59+
.. warning::
60+
61+
We strongly recommend to :ref:`pin the MkDocs version <guides/specifying-dependencies:Specifying Dependencies>`
62+
used for your project to build the docs to avoid potential future incompatibilities.
63+
64+
5965
Understanding what's going on
6066
-----------------------------
6167

0 commit comments

Comments
 (0)