From 072a57503b3ec8b0d96a65560655ddc3bea957f6 Mon Sep 17 00:00:00 2001 From: Glen Whitney Date: Tue, 9 Feb 2021 09:40:31 -0800 Subject: [PATCH] chore: Make HtmlProofer happy by shutting up flake8 with # noqa --- README.md | 2 +- mkdocs_semiliterate/plugin.py | 8 +++----- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ccaab3b..ff88169 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MkDocs semiliterate Plugin -This plugin for [MkDocs](https://mkdocs.org) is an extension of Allison Thackston's excellent [mkdocs-simple-plugin](https://athackst.github.io/mkdocs-simple-plugin). It allows you to include content from one file into another (via `{! ... !}` syntax), using exactly the same extraction specification that the `simple` plugin already uses for identifying documentation in source files. +This plugin for [MkDocs](http://mkdocs.org) is an extension of Allison Thackston's excellent [mkdocs-simple-plugin](https://athackst.github.io/mkdocs-simple-plugin). It allows you to include content from one file into another (via `{! ... !}` syntax), using exactly the same extraction specification that the `simple` plugin already uses for identifying documentation in source files. ## Rationale diff --git a/mkdocs_semiliterate/plugin.py b/mkdocs_semiliterate/plugin.py index 1d58982..e366576 100644 --- a/mkdocs_semiliterate/plugin.py +++ b/mkdocs_semiliterate/plugin.py @@ -36,8 +36,7 @@ enclosed in single or double quotes. Note that FILENAME is interpreted relative to the directory in which the file containing the `{! .. !}` expression resides. The YAML is interpreted exactly as the extraction options to a `semiliterate` item as -[documented](https://athackst.github.io/mkdocs-simple-plugin/ -mkdocs_simple_plugin/plugin/index.html#semiliterate) +[documented](https://athackst.github.io/mkdocs-simple-plugin/mkdocs_simple_plugin/plugin/index.html#semiliterate) for the `simple` extension. The text extracted from FILENAME is interpolated at the current location in the file currently being written. Recursive inclusion is supported. @@ -62,8 +61,7 @@ to take advantage of the beginning of the `setup.cfg` file: (and of course both of the code snippets just above are extracted into this page with `{! ... !}`, as you can see in the -[source code](https://code.studioinfinity.org/glen/mkdocs-semiliterate/src/ -branch/main/mkdocs_semiliterate/plugin.py) +[source code](https://code.studioinfinity.org/glen/mkdocs-semiliterate/src/branch/main/mkdocs_semiliterate/plugin.py) for the plugin.) Note that a `{! ... !}` directive must be in a line that semiliterate would @@ -74,7 +72,7 @@ special expressions, including `start` and `stop`. Moreover, on such normally-transcribed lines, it's the text **after** the application of any semiliterate `replace`ments that is checked for `{! ... !}`. - """ + """ # noqa: E501 include_open = re.compile(r'''(?