b1203327ad
feat: Allow semiliterate to adjust the theme
...
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
86010351b7
doc: Add a reminder to the Publishing section
continuous-integration/drone/push Build is failing
2022-08-02 05:03:48 +00:00
c87dd60c5e
Merge pull request 'fix(destination): Allow the destination to reside in an arbitrary directory' ( #21 ) from fix/sibling_destination into main
...
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
continuous-integration/drone/tag Build is failing
Reviewed-on: #21
2022-08-02 04:39:03 +00:00
f85c5fc6eb
fix(destination): Allow the destination to reside in an arbitrary directory
...
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 )
...
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
6247034203
Merge pull request 'feat: Add extract_on_copy
option' ( #18 ) from copy_first into main
...
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
Reviewed-on: #18
2022-07-12 19:32:39 +00:00
9d75fefb81
feat: Add extract_on_copy
option
...
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
06cce2edc3
Merge pull request 'chore: Update required version of mkdocs-simple-plugin' ( #16 ) from simple1_1 into main
...
continuous-integration/drone/push Build is passing
Reviewed-on: #16
2022-07-11 23:56:38 +00:00
73329df1b7
chore: Update required version of mkdocs-simple-plugin
continuous-integration/drone Build is passing
2022-07-11 15:43:21 -07:00
8e156df41b
chore: Try 'Source' URL in addition to 'Source Code' to see if it satisfies SourceRank
continuous-integration/drone Build was killed
continuous-integration/drone/push Build is passing
2021-08-24 19:08:51 -07:00
14de19f10c
doc: Add a note about publishing to PyPI
continuous-integration/drone/push Build is passing
2021-08-24 15:47:33 -07:00
951907c67a
Merge pull request 'chore: Update to mkdocs-simple-plugin v1.0' ( #15 ) from simple1_0 into main
...
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
continuous-integration/drone/tag Build is passing
Reviewed-on: #15
2021-08-24 22:01:55 +00:00
b4a49b67b8
chore: Update to mkdocs-simple-plugin v1.0
...
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 )
...
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
d0028497dc
fix: remove unnecessary commas from URLs for next release
continuous-integration/drone/push Build is passing
2021-02-09 10:47:35 -08:00
b9d9b7ac0d
docs: Prepare for PyPI publication ( #10 )
...
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
0b0c458011
refactor: Build on top of released mkdocs-simple-plugin v0.4.0 ( #8 )
...
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
continuous-integration/drone/tag Build is passing
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
e84dee4757
feat: add exclude_extensions plugin parameter
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
2021-01-28 16:29:50 -08:00
d0904e40cb
refactor: Adjust again to latest 'simple' commit
...
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
...
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
4247c5d875
docs: Add version number to site
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
2021-01-10 09:29:40 -08:00
82602a4bbe
fix: Allow bare `{! file.md !}' inclusion
...
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
...
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
...
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
981384c6f7
feat: Make the start
parameter to a semiliterate pattern optional
...
continuous-integration/drone/push Build is failing
Resolves #4 .
2021-01-09 08:42:00 -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
ea8e65ae64
feat: Add inclusion syntax for extracted content
...
Also updated the documentation, using the extraction syntax.
Resolves #2 .
2021-01-08 11:36:03 -08:00
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
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
6004ed0c0f
Initial commit
2021-01-08 04:10:06 +00:00