Commit Graph

12 Commits

Author SHA1 Message Date
Glen Whitney f85c5fc6eb fix(destination): Allow the destination to reside in an arbitrary directory
continuous-integration/drone/push Build was killed Details
continuous-integration/drone/pr Build is passing Details
That is to say, the destination will now be interpreted as an entire
  path relative to the source, not simply a filename in the same directory
  as the source.

  Resolves #20.
2022-08-01 21:30:30 -07:00
Glen Whitney 04a410a85b fix: Improve error message when a scan fails (#19)
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
Also syncs somewhat better with the latest release of mkdocs-simple-plugin
  and corrects some typos.

Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #19
2022-08-02 03:01:26 +00:00
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 b4a49b67b8 chore: Update to mkdocs-simple-plugin v1.0
continuous-integration/drone Build is passing Details
Also updates from pep517.build to the `build` package, and bumps the
  semiliterate version number.
  Resolves #14.
2021-08-24 10:58:55 -07:00
Glen Whitney f458f716e3 feat: Implement double-quoted filename features. (#13)
continuous-integration/drone/tag Build is passing Details
continuous-integration/drone/push Build is failing Details
Adds interpretation of ordinary Python character escapes (like "\t") and
  a special escape to fetch a particular Git version of a file, in double-quoted
  strings used as the FILENAME argument of a {! ... !} inclusion directive.

  Resolves #11.
  Resolves #12.

Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #13
Co-Authored-By: Glen Whitney <glen@nobody@nowhere.net>
Co-Committed-By: Glen Whitney <glen@nobody@nowhere.net>
2021-02-12 17:11:07 +00: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 d0904e40cb refactor: Adjust again to latest 'simple' commit
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
Now with even less code!
2021-01-15 09:44:25 -08:00
Glen Whitney 5a1f9e044a refactor: Adjust to latest commit of simple plugin
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
Now reiterates significantly less code from the simple plugin. Also, adjusted
  the default for extract_standard_markdown when copy_standard_markdown is true.
2021-01-13 21:36:29 -08:00
Glen Whitney 82602a4bbe fix: Allow bare `{! file.md !}' inclusion
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
Also moves the site tests into a bash script.

  Resolves #6.
2021-01-10 09:16:40 -08:00
Glen Whitney 03f3cc811b chore: set up automated deployment
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
Now, when one promotes a build in Drone to "release," the website should
  automatically be copied to studioinfinity.org
2021-01-09 20:17:20 -08: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
Glen Whitney 2235af160c test: add Drone tests
Also includes installation and development documentation, and updates
  to the latest development version of mkdocs-simple-plugin.

  Resolves #3.
2021-01-09 08:11:30 -08:00