From 8105144d82c733cf43e3f32656ba6163e0dd5fdc Mon Sep 17 00:00:00 2001 From: Glen Whitney Date: Sun, 15 Sep 2024 18:49:57 +0000 Subject: [PATCH] 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: https://code.studioinfinity.org/glen/mkdocs-semiliterate/pulls/24 Co-authored-by: Glen Whitney Co-committed-by: Glen Whitney --- .drone.yml | 7 +- mkdocs.yml | 2 +- setup.cfg | 2 +- .../refsite/404.html.cropped | 13 +- .../extract-inclusion/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../refsite/index.html.cropped | 23 +- .../refsite/polished/index.html.cropped | 23 +- .../full-inclusion/refsite/404.html.cropped | 7 +- .../full-inclusion/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../full-inclusion/refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../full-inclusion/refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../full-inclusion/refsite/index.html.cropped | 15 +- .../git-inclusion/refsite/404.html.cropped | 7 +- .../git-inclusion/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../git-inclusion/refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../git-inclusion/refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../git-inclusion/refsite/index.html.cropped | 15 +- .../refsite/404.html.cropped | 7 +- .../no-extract-inclusion/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../refsite/index.html.cropped | 15 +- .../quoted-filename/refsite/404.html.cropped | 7 +- .../quoted-filename/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../quoted-filename/refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../refsite/index.html.cropped | 15 +- .../refsite/404.html.cropped | 13 +- .../recursive-inclusion/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../refsite/foo/index.html.cropped | 23 +- .../refsite/index.html.cropped | 23 +- .../refsite/404.html.cropped | 15 +- .../sibling-destination/refsite/css/base.css | 142 +- .../refsite/css/bootstrap.min.css | 18 +- .../refsite/css/bootstrap.min.css.map | 1 + .../refsite/css/brands.min.css | 6 + .../refsite/css/font-awesome.min.css | 4 - .../refsite/css/fontawesome.min.css | 9 + .../refsite/css/solid.min.css | 6 + .../refsite/css/v4-font-face.min.css | 6 + .../finished/polished/index.html.cropped | 25 +- .../refsite/fonts/fontawesome-webfont.eot | Bin 165742 -> 0 bytes .../refsite/fonts/fontawesome-webfont.svg | 2671 ----------------- .../refsite/fonts/fontawesome-webfont.ttf | Bin 165548 -> 0 bytes .../refsite/fonts/fontawesome-webfont.woff | Bin 98024 -> 0 bytes .../refsite/fonts/fontawesome-webfont.woff2 | Bin 77160 -> 0 bytes .../refsite/img/favicon.ico | Bin 1150 -> 0 bytes .../sibling-destination/refsite/img/grid.png | Bin 1458 -> 0 bytes .../refsite/index.html.cropped | 25 +- .../sibling-destination/refsite/js/base.js | 283 -- .../refsite/js/bootstrap.min.js | 7 - .../refsite/js/jquery-1.10.2.min.js | 6 - .../sibling-destination/refsite/sitemap.xml | 13 - .../refsite/sitemap.xml.gz | Bin 194 -> 0 bytes .../refsite/404.html.cropped | 6 +- .../refsite/css/fonts/Roboto-Slab-Bold.woff | Bin 87624 -> 0 bytes .../refsite/css/fonts/Roboto-Slab-Bold.woff2 | Bin 67312 -> 0 bytes .../css/fonts/Roboto-Slab-Regular.woff | Bin 86288 -> 0 bytes .../css/fonts/Roboto-Slab-Regular.woff2 | Bin 66444 -> 0 bytes .../refsite/css/fonts/fontawesome-webfont.eot | Bin 165742 -> 0 bytes .../refsite/css/fonts/fontawesome-webfont.svg | 2671 ----------------- .../refsite/css/fonts/fontawesome-webfont.ttf | Bin 165548 -> 0 bytes .../css/fonts/fontawesome-webfont.woff | Bin 98024 -> 0 bytes .../css/fonts/fontawesome-webfont.woff2 | Bin 77160 -> 0 bytes .../refsite/css/fonts/lato-bold-italic.woff | Bin 323344 -> 0 bytes .../refsite/css/fonts/lato-bold-italic.woff2 | Bin 193308 -> 0 bytes .../refsite/css/fonts/lato-bold.woff | Bin 309728 -> 0 bytes .../refsite/css/fonts/lato-bold.woff2 | Bin 184912 -> 0 bytes .../refsite/css/fonts/lato-normal-italic.woff | Bin 328412 -> 0 bytes .../css/fonts/lato-normal-italic.woff2 | Bin 195704 -> 0 bytes .../refsite/css/fonts/lato-normal.woff | Bin 309192 -> 0 bytes .../refsite/css/fonts/lato-normal.woff2 | Bin 182708 -> 0 bytes .../theme-modification/refsite/css/theme.css | 6 +- .../refsite/css/theme_extra.css | 10 +- .../refsite/img/favicon.ico | Bin 1150 -> 0 bytes .../refsite/index.html.cropped | 10 +- .../refsite/js/html5shiv.min.js | 4 - .../refsite/js/jquery-3.6.0.min.js | 2 - .../theme-modification/refsite/js/theme.js | 2 - .../refsite/js/theme_extra.js | 8 - .../theme-modification/refsite/sitemap.xml | 8 - .../theme-modification/refsite/sitemap.xml.gz | Bin 188 -> 0 bytes tests/sites.bash | 3 +- 117 files changed, 1066 insertions(+), 6270 deletions(-) create mode 100644 tests/fixtures/extract-inclusion/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/extract-inclusion/refsite/css/brands.min.css delete mode 100644 tests/fixtures/extract-inclusion/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/extract-inclusion/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/extract-inclusion/refsite/css/solid.min.css create mode 100644 tests/fixtures/extract-inclusion/refsite/css/v4-font-face.min.css create mode 100644 tests/fixtures/full-inclusion/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/full-inclusion/refsite/css/brands.min.css delete mode 100644 tests/fixtures/full-inclusion/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/full-inclusion/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/full-inclusion/refsite/css/solid.min.css create mode 100644 tests/fixtures/full-inclusion/refsite/css/v4-font-face.min.css create mode 100644 tests/fixtures/git-inclusion/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/git-inclusion/refsite/css/brands.min.css delete mode 100644 tests/fixtures/git-inclusion/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/git-inclusion/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/git-inclusion/refsite/css/solid.min.css create mode 100644 tests/fixtures/git-inclusion/refsite/css/v4-font-face.min.css create mode 100644 tests/fixtures/no-extract-inclusion/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/no-extract-inclusion/refsite/css/brands.min.css delete mode 100644 tests/fixtures/no-extract-inclusion/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/no-extract-inclusion/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/no-extract-inclusion/refsite/css/solid.min.css create mode 100644 tests/fixtures/no-extract-inclusion/refsite/css/v4-font-face.min.css create mode 100644 tests/fixtures/quoted-filename/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/quoted-filename/refsite/css/brands.min.css delete mode 100644 tests/fixtures/quoted-filename/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/quoted-filename/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/quoted-filename/refsite/css/solid.min.css create mode 100644 tests/fixtures/quoted-filename/refsite/css/v4-font-face.min.css create mode 100644 tests/fixtures/recursive-inclusion/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/recursive-inclusion/refsite/css/brands.min.css delete mode 100644 tests/fixtures/recursive-inclusion/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/recursive-inclusion/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/recursive-inclusion/refsite/css/solid.min.css create mode 100644 tests/fixtures/recursive-inclusion/refsite/css/v4-font-face.min.css create mode 100644 tests/fixtures/sibling-destination/refsite/css/bootstrap.min.css.map create mode 100644 tests/fixtures/sibling-destination/refsite/css/brands.min.css delete mode 100644 tests/fixtures/sibling-destination/refsite/css/font-awesome.min.css create mode 100644 tests/fixtures/sibling-destination/refsite/css/fontawesome.min.css create mode 100644 tests/fixtures/sibling-destination/refsite/css/solid.min.css create mode 100644 tests/fixtures/sibling-destination/refsite/css/v4-font-face.min.css delete mode 100644 tests/fixtures/sibling-destination/refsite/fonts/fontawesome-webfont.eot delete mode 100644 tests/fixtures/sibling-destination/refsite/fonts/fontawesome-webfont.svg delete mode 100644 tests/fixtures/sibling-destination/refsite/fonts/fontawesome-webfont.ttf delete mode 100644 tests/fixtures/sibling-destination/refsite/fonts/fontawesome-webfont.woff delete mode 100644 tests/fixtures/sibling-destination/refsite/fonts/fontawesome-webfont.woff2 delete mode 100644 tests/fixtures/sibling-destination/refsite/img/favicon.ico delete mode 100644 tests/fixtures/sibling-destination/refsite/img/grid.png delete mode 100644 tests/fixtures/sibling-destination/refsite/js/base.js delete mode 100644 tests/fixtures/sibling-destination/refsite/js/bootstrap.min.js delete mode 100644 tests/fixtures/sibling-destination/refsite/js/jquery-1.10.2.min.js delete mode 100644 tests/fixtures/sibling-destination/refsite/sitemap.xml delete mode 100644 tests/fixtures/sibling-destination/refsite/sitemap.xml.gz delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Bold.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Bold.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Regular.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Regular.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.eot delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.svg delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.ttf delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-bold-italic.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-bold-italic.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-bold.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-bold.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-normal-italic.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-normal-italic.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-normal.woff delete mode 100644 tests/fixtures/theme-modification/refsite/css/fonts/lato-normal.woff2 delete mode 100644 tests/fixtures/theme-modification/refsite/img/favicon.ico delete mode 100644 tests/fixtures/theme-modification/refsite/js/html5shiv.min.js delete mode 100644 tests/fixtures/theme-modification/refsite/js/jquery-3.6.0.min.js delete mode 100644 tests/fixtures/theme-modification/refsite/js/theme.js delete mode 100644 tests/fixtures/theme-modification/refsite/js/theme_extra.js delete mode 100644 tests/fixtures/theme-modification/refsite/sitemap.xml delete mode 100644 tests/fixtures/theme-modification/refsite/sitemap.xml.gz diff --git a/.drone.yml b/.drone.yml index 40edd55..7b4477d 100644 --- a/.drone.yml +++ b/.drone.yml @@ -6,6 +6,11 @@ # ``` # git clone https://code.studioinfinity.org/glen/mkdocs-semiliterate # ``` +# +# For the remaining steps, it may be easiest to do them in a python +# virtual environment. If you put the virtual environment in `.venv` at +# the top level of the project, it will not disrupt any of the tests. +# Remember to activate your virtual environment before doing the testing. ### kind: pipeline name: bootstrap @@ -42,7 +47,7 @@ steps: # starting from the top-level `mkdocs-semiliterate` directory, run the commands # that drone uses to test: # ``` - - flake8 --max-line-length=80 --extend-exclude=build + - flake8 --max-line-length=80 --extend-exclude=build --extend-exclude=.venv - mkdocs build - find site -not -path '*fonts*' -not -path '*img*' -not -path '*js*' | sort -f | diff tests/bootstrap.manifest - - bash tests/sites.bash diff --git a/mkdocs.yml b/mkdocs.yml index 71b1352..a4dd21a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,7 +7,7 @@ plugins: - search - semiliterate: merge_docs_dir: false - ignore_folders: [build, dist, tests, semiliterate] + ignore_folders: [build, dist, tests, semiliterate, .venv] ignore_hidden: false include_extensions: [LICENSE, '.png'] extract_standard_markdown: diff --git a/setup.cfg b/setup.cfg index 42d05ac..e8d3d4c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = mkdocs-semiliterate -version = 0.7.0 +version = 0.7.1 description = Extension of mkdocs-simple-plugin adding easy content inclusion long_description = file: README.md long_description_content_type = text/markdown diff --git a/tests/fixtures/extract-inclusion/refsite/404.html.cropped b/tests/fixtures/extract-inclusion/refsite/404.html.cropped index 0182f40..58f266d 100644 --- a/tests/fixtures/extract-inclusion/refsite/404.html.cropped +++ b/tests/fixtures/extract-inclusion/refsite/404.html.cropped @@ -1,5 +1,5 @@ - + @@ -8,7 +8,6 @@ Enable extraction from included files - @@ -16,7 +15,7 @@ @@ -64,7 +63,7 @@