feat: Add extract_on_copy option #18

glen · 2022-07-12T19:22:36Z

glen commented

2022-07-12 19:22:36 +00:00

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.

Bumps the version to 0.4.0.

Resolves #17.

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. Bumps the version to 0.4.0. Resolves #17.

glen added 1 commit 2022-07-12 19:22:36 +00:00

continuous-integration/drone/push Build is passing Details

continuous-integration/drone/pr Build is passing Details

9d75fefb81 feat: Add `extract_on_copy` option

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.

glen merged commit 6247034203 into main

2022-07-12 19:32:40 +00:00

glen referenced this issue from a commit

2022-07-12 19:32:40 +00:00

Merge pull request 'feat: Add `extract_on_copy` option' (#18) from copy_first into main

glen deleted branch copy_first

2022-07-12 19:32:51 +00:00

Sign in to join this conversation.

No reviewers