diff options
-rw-r--r-- | .readthedocs.yaml | 14 | ||||
-rw-r--r-- | docs/faq.rst | 2 | ||||
-rw-r--r-- | docs/requirements-post.txt | 1 | ||||
-rw-r--r-- | docs/requirements.txt | 1 |
4 files changed, 17 insertions, 1 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6cbcad7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3.9" +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . + - requirements: docs/requirements-post.txt +sphinx: + builder: dirhtml + fail_on_warning: false diff --git a/docs/faq.rst b/docs/faq.rst index 294fef1..3d38e10 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -95,7 +95,7 @@ means that you will less likely have an XSS problem it also causes a huge amount of extra processing in the template engine which can cause serious performance problems. As Python doesn't provide a way to mark strings as unsafe Jinja has to hack around that limitation by providing a custom -string class (the :class:`Markup` string) that safely interacts with safe +string class (the :class:`~markupsafe.Markup` string) that safely interacts with safe and unsafe strings. With explicit escaping however the template engine doesn't have to perform diff --git a/docs/requirements-post.txt b/docs/requirements-post.txt new file mode 100644 index 0000000..44857c8 --- /dev/null +++ b/docs/requirements-post.txt @@ -0,0 +1 @@ +markupsafe<2 diff --git a/docs/requirements.txt b/docs/requirements.txt index cfe1fd7..92d3efa 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,3 +2,4 @@ Sphinx~=2.1.2 Pallets-Sphinx-Themes~=1.2.0 sphinxcontrib-log-cabinet~=1.0.1 sphinx-issues~=1.2.0 +markupsafe<2 |