Commit Graph

3 Commits

Author SHA1 Message Date
Glen Whitney 9d75fefb81 feat: Add `extract_on_copy` option
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/pr Build is passing Details
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.
2022-07-12 12:14:41 -07:00
Glen Whitney b9d9b7ac0d docs: Prepare for PyPI publication (#10)
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
continuous-integration/drone/tag Build is passing Details
Update installation instructions to reflect ability to use `pip`.
  Add concrete examples of extraction.

  Resolves #9.

Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #10
Co-Authored-By: Glen Whitney <glen@nobody@nowhere.net>
Co-Committed-By: Glen Whitney <glen@nobody@nowhere.net>
2021-02-09 17:47:02 +00:00
Glen Whitney ec0854d8b9 feat: Add `extract_standard_markdown` and `report_docs_build` parameters
continuous-integration/drone/push Build was killed Details
Also includes the bootstrap manifest, which was inadvertently '.gitignore'd.

  Resolves #5.
2021-01-09 10:17:34 -08:00