Glen Whitney
9d75fefb81
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.
31 lines
821 B
YAML
31 lines
821 B
YAML
site_name: MkDocs semiliterate plugin
|
|
nav:
|
|
- Overview: README.md
|
|
- Usage: mkdocs_semiliterate/plugin.md
|
|
- Developing: drone_develop.md
|
|
plugins:
|
|
- search
|
|
- semiliterate:
|
|
merge_docs_dir: false
|
|
ignore_folders: [build, dist, tests, semiliterate]
|
|
include_extensions: [LICENSE, '.png']
|
|
extract_standard_markdown:
|
|
extract:
|
|
replace: [['^(.*)<!-- repo: -->.*<!-- site:(.*?) -->(.*\s*)$', '\1\2\3']]
|
|
semiliterate:
|
|
- pattern: '\.py$'
|
|
extract: {start: '"""\smd', stop: '"""'}
|
|
- pattern: '.drone.yml'
|
|
destination: 'drone_develop.md'
|
|
extract:
|
|
start: '### develop'
|
|
stop: '^\s*###'
|
|
replace: ['^# (.*\s*)$', '^\s*-(.*\s*)$']
|
|
markdown_extensions:
|
|
- abbr
|
|
- def_list
|
|
- smarty
|
|
theme:
|
|
name: readthedocs
|
|
docs_dir: mkdocs_semiliterate # dummy
|