glen/mkdocs-semiliterate
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 11 Wiki Activity

docs: Prepare for PyPI publication #10

Merged
glen merged 4 commits from pip_install into main 2021-02-09 17:47:03 +00:00
Conversation 0 Commits 4 Files Changed 6 +4 -6
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 072a57503b - Show all commits

2
README.md
View File

@ -1,6 +1,6 @@
# MkDocs semiliterate Plugin # 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.
<!-- repo: --><!-- site: The current version of mkdocs-semiliterate is {! setup.cfg { extract: {start: name}, terminate: '(\d*\.\d*\.\d*)'} !}. --> <!-- repo: --><!-- site: The current version of mkdocs-semiliterate is {! setup.cfg { extract: {start: name}, terminate: '(\d*\.\d*\.\d*)'} !}. -->
## Rationale ## Rationale

8
mkdocs_semiliterate/plugin.py
View File

@ -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 to the directory in which the file containing the `{! .. !}` expression
resides. The YAML is interpreted exactly as the extraction options to a resides. The YAML is interpreted exactly as the extraction options to a
`semiliterate` item as `semiliterate` item as
[documented](https://athackst.github.io/mkdocs-simple-plugin/ [documented](https://athackst.github.io/mkdocs-simple-plugin/mkdocs_simple_plugin/plugin/index.html#semiliterate)
mkdocs_simple_plugin/plugin/index.html#semiliterate)
for the `simple` extension. The text extracted from FILENAME for the `simple` extension. The text extracted from FILENAME
is interpolated at the current location in the file currently being written. is interpolated at the current location in the file currently being written.
Recursive inclusion is supported. 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 (and of course both of the code snippets just above are extracted into this
page with `{! ... !}`, as you can see in the page with `{! ... !}`, as you can see in the
[source code](https://code.studioinfinity.org/glen/mkdocs-semiliterate/src/ [source code](https://code.studioinfinity.org/glen/mkdocs-semiliterate/src/branch/main/mkdocs_semiliterate/plugin.py)
branch/main/mkdocs_semiliterate/plugin.py)
for the plugin.) for the plugin.)
Note that a `{! ... !}` directive must be in a line that semiliterate would 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, Moreover, on such normally-transcribed lines,
it's the text **after** the application of any semiliterate `replace`ments that it's the text **after** the application of any semiliterate `replace`ments that
is checked for `{! ... !}`. is checked for `{! ... !}`.
""" """ # noqa: E501
include_open = re.compile(r'''(?<![`\\])(\{\!\s*)([\s'"])''') include_open = re.compile(r'''(?<![`\\])(\{\!\s*)([\s'"])''')
include_quoted_file = re.compile( include_quoted_file = re.compile(