Commit Graph

16 Commits

Author SHA1 Message Date
b6ab0fb7ee chore: Update to latest mkdocs-simple 3.2.0 (#25)
Reviewed-on: #25
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Co-committed-by: Glen Whitney <glen@studioinfinity.org>
2024-09-16 02:34:34 +00:00
8105144d82 chore: Allow building from venv; bump version (#24)
Also had to update the test fixtures because mkdocs, bootstrap, whatever it may be have changed, so the sites end up slightly different.

Reviewed-on: #24
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Co-committed-by: Glen Whitney <glen@studioinfinity.org>
2024-09-15 18:49:57 +00:00
4a4241a4e4 chore: Update to mkdocs-simple v2.1.2 (#23)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
continuous-integration/drone Build is passing
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
b1203327ad feat: Allow semiliterate to adjust the theme
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
The mechanism here is to shadow a specified `custom.theme_dir` in the
  generated docs directory, and then ignore generated files therein (since they
  will be being used by the theme to render the pages, and are not actually
  part of the documentation).
2022-08-09 08:17:37 -07:00
f85c5fc6eb fix(destination): Allow the destination to reside in an arbitrary directory
Some checks reported errors
continuous-integration/drone/push Build was killed
continuous-integration/drone/pr Build is passing
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
04a410a85b fix: Improve error message when a scan fails (#19)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
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
9d75fefb81 feat: Add extract_on_copy option
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
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
b4a49b67b8 chore: Update to mkdocs-simple-plugin v1.0
All checks were successful
continuous-integration/drone Build is passing
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
f458f716e3 feat: Implement double-quoted filename features. (#13)
Some checks failed
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is failing
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
b9d9b7ac0d docs: Prepare for PyPI publication (#10)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
continuous-integration/drone/tag Build is passing
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
d0904e40cb refactor: Adjust again to latest 'simple' commit
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
Now with even less code!
2021-01-15 09:44:25 -08:00
5a1f9e044a refactor: Adjust to latest commit of simple plugin
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
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
82602a4bbe fix: Allow bare `{! file.md !}' inclusion
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
Also moves the site tests into a bash script.

  Resolves #6.
2021-01-10 09:16:40 -08:00
03f3cc811b chore: set up automated deployment
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
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
ec0854d8b9 feat: Add extract_standard_markdown and report_docs_build parameters
Some checks reported errors
continuous-integration/drone/push Build was killed
Also includes the bootstrap manifest, which was inadvertently '.gitignore'd.

  Resolves #5.
2021-01-09 10:17:34 -08:00
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