refactor: Build on top of released mkdocs-simple-plugin v0.4.0 (#8)
Includes documentation updates, particularly for installation. Removes a now-duplicate parameter. Adds project metadata. Should be ready for release. Resolves #7. Co-authored-by: Glen Whitney <glen@studioinfinity.org> Reviewed-on: #8 Co-Authored-By: Glen Whitney <glen@nobody@nowhere.net> Co-Committed-By: Glen Whitney <glen@nobody@nowhere.net>
This commit is contained in:
parent
e84dee4757
commit
0b0c458011
6 changed files with 31 additions and 27 deletions
1
mkdocs_semiliterate/__init__.py
Normal file
1
mkdocs_semiliterate/__init__.py
Normal file
|
@ -0,0 +1 @@
|
|||
"""mkdocs_semiliterate package."""
|
|
@ -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']:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue