Removes a block of code from mkdocs_simple_plugin of dubious purpose
that crashes any time it triggers. All tests pass without.
Resolves#30.
Reviewed-on: #31
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Co-committed-by: Glen Whitney <glen@studioinfinity.org>
The custom theme dir handling was not working in case the mkdocs config
file was not in the top-level directory. Since mkdocs itself seems only
to work in the top-level directory, this PR modifies mkdocs_semiliterate
to interpret custom theme dirs relative to the current directory.
Also, improves the harmonization between current mkdocs_simple_plugin
code and this code.
Resolves#28.
Reviewed-on: #29
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Co-committed-by: Glen Whitney <glen@studioinfinity.org>
Note the upstream refactor from mkdocs-simple v1 -> v2 was fairly large, so
this is a rather larger update than most. And in fact one feature of
mkdocs-semiliterate (universal markdown extraction) was incorporated into
mkdocs-simple, so the initialization of this plugin is noticeably simplified
as a result.
Also updates mkdocs to 1.4.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #23
The mechanism here is to shadow a specified `custom.theme_dir` in the
generated docs directory, and then ignore generated files therein (since they
will be being used by the theme to render the pages, and are not actually
part of the documentation).
That is to say, the destination will now be interpreted as an entire
path relative to the source, not simply a filename in the same directory
as the source.
Resolves#20.
Also syncs somewhat better with the latest release of mkdocs-simple-plugin
and corrects some typos.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #19
Previously, mkdocs_semiliterate would always attempt to extract documentation
from a file, even if it matched the `include_extensions` pattern for files to
be copied to the documentation site verbatim.
Now, by default, such files are not considered candidates for extraction,
even if they match a semiliterate pattern.
Adds a configuration option `extract_on_copy` which can be set to `true` to
restore the prior behavior. Also adds tests for the behavior with and without
`extract_on_copy` and makes all `mkdocs build` commands in the tests strict,
which they always should have been.
Resolves#17.
Adds interpretation of ordinary Python character escapes (like "\t") and
a special escape to fetch a particular Git version of a file, in double-quoted
strings used as the FILENAME argument of a {! ... !} inclusion directive.
Resolves#11.
Resolves#12.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #13
Co-Authored-By: Glen Whitney <glen@nobody@nowhere.net>
Co-Committed-By: Glen Whitney <glen@nobody@nowhere.net>
Now reiterates significantly less code from the simple plugin. Also, adjusted
the default for extract_standard_markdown when copy_standard_markdown is true.
Also provides semiliterate plugin stub, lays out basic initial documentation
for the project, and adds a simple mkdocs.yml file that builds a rudimentary
documentation site.
