Commit Graph

11 Commits

Author SHA1 Message Date
Glen Whitney 4a4241a4e4 chore: Update to mkdocs-simple v2.1.2 (#23)
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/tag Build is passing Details
continuous-integration/drone Build is passing Details
Note the upstream refactor from mkdocs-simple v1 -> v2 was fairly large, so
  this is a rather larger update than most. And in fact one feature of
  mkdocs-semiliterate (universal markdown extraction) was incorporated into
  mkdocs-simple, so the initialization of this plugin is noticeably simplified
  as a result.

  Also updates mkdocs to 1.4.

Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Reviewed-on: #23
2022-11-09 20:52:47 +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 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 0b0c458011 refactor: Build on top of released mkdocs-simple-plugin v0.4.0 (#8)
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build is passing Details
continuous-integration/drone/tag Build is passing Details
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>
2021-02-09 06:26:39 +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 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 981384c6f7 feat: Make the `start` parameter to a semiliterate pattern optional
continuous-integration/drone/push Build is failing Details
Resolves #4.
2021-01-09 08:42:00 -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
Glen Whitney cf4d538fd0 feat: Add copy_standard_markdown parameter to plugin
This parameter controls whether the standard markdown extensions will
  be added to the include_extensions or not.

  Resolves #1.
2021-01-08 10:40:06 -08:00
Glen Whitney ec9c7e57ce chore: initialize setuptools project
Also provides semiliterate plugin stub, lays out basic initial documentation
  for the project, and adds a simple mkdocs.yml file that builds a rudimentary
  documentation site.
2021-01-07 22:39:40 -08:00