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

refactor: Remove report_docs_build parameter

Browse source 
The underlying mkdocs_simple_plugin now itself reports the doc build
  directory. This commit also updates the documentation slightly.
This commit is contained in:
Glen Whitney 2021-02-08 21:41:24 -08:00
parent e84dee4757
commit be97842c90
4 changed files with 9 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

10
mkdocs_semiliterate/plugin.py
View file

@ -152,7 +152,7 @@ terminate: '^\s*\)'
# `semiliterate` still incorporates all standard Markdown files
# because of the following `extract_standard_markdown` parameter.
('extract_standard_markdown',
config_options.Type(dict, default={})),
config_options.Type(dict, default={}))
# If the `enable` key of this dict parameter is true
# (it defaults to the opposite of `copy_standard_markdown`),
# it adds a semiliterate block causing extraction (and hence
@ -164,17 +164,9 @@ terminate: '^\s*\)'
# On the other hand, setting this parameter to `{enable: false}`
# (which is also the default when `copy_standard_markdown` is true)
# will prevent automatic extraction from standard Markdown files.
('report_docs_build',
config_options.Type(bool, default=False))
# If true, the name of the temporary directory to which generated docs
# files are copied/extracted will be written to standard output
# (even if the `-v` verbose option to mkdocs is not specified).
)
def build_docs(self):
if self.config['report_docs_build']:
utils.log.info(
f"semiliterate: generating docs in {self.build_docs_dir}")
self.exclude_extensions = self.config['exclude_extensions']
dflt_enable = False
if not self.config['copy_standard_markdown']: