From 9a5d04f020421afe369db73f2619def869f28a6f Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Wed, 28 Feb 2024 12:05:27 -0800 Subject: [PATCH 01/21] =?UTF-8?q?=F0=9F=91=B7=20Implement=20automatic=20bu?= =?UTF-8?q?ilding=20+=20deployment=20of=20GitHub=20Pages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR closes #40 and brings in a few changes to the general build workflow: 1. [`poetry`][1] is now used to setup a virtual environment separate from your global environment to allow having a uniform installation of tools. 2. `cps` now exists as a sphinx plugin + module and is "installable". This also applies for the forked/modified `autosectionlabel`. Details on how to add additional custom extensions can be found in the `pyproject.toml` file (`tool.poetry.packages` and the `tool.poetry.plugins."sphinx-builders"` sections) 3. We do NOT use the github [upload-pages-artifact][2] action, as we can package + fixup permissions in one move. 4. We do NOT use the Makefile during the CI step. 5. We cache sphinx dependencies now so when upgrading/installing things should go much faster (especially on PRs) GitHub Pages *do not yet support* previews of PRs for the general public. However, GitHub Pages alternatives such as Cloudflare Pages *do*. This is something I'd recommend considering if having per-commit + per-branch previews is desired. > [!TIP] > I'd recommend *possibly* putting some approvals for the actual final > deployment to GitHub Pages in place Lastly, I took an extra step and added a spellchecker for the github actions steps. Unfortunately, they do not currently support having generalized tags for a specific version. Keeping up to date with it without automation would be difficult. For this reason, we're currently using `@master`. However, I'd recommend considering installing [renovatebot][3] to help keep our github actions workflows up to date and also *pinned* to specific git commit hashes. You can see how this operates in practice by looking at [my personal `workflow_call` capable workflows][4] and how they've managed to keep actions pinned and up to date for *quite some time*. The usage of renovatebot requires the installation at the organization level, and so I'm unable to actually turn it on for CPS itself 🙂 > [!NOTE] > I understand this is a lot of suggestions + changes, and also this > initial PR might shit the bed right out of the gate, but we can get that > resolved ASAP. [1]: https://python-poetry.org [2]: https://github.com/actions/upload-pages-artifact/ [3]: https://docs.renovatebot.com/ [4]: https://github.com/bruxisma/actions/pulls?q=is%3Apr+is%3Aclosed --- .github/workflows/docs.yml | 57 +++ .github/workflows/spellcheck.yml | 15 + conf.py | 2 +- {_ext => extensions}/autosectionlabel.py | 0 {_ext => extensions}/cps.py | 0 poetry.lock | 474 +++++++++++++++++++++++ pyproject.toml | 28 ++ 7 files changed, 575 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml create mode 100644 .github/workflows/spellcheck.yml rename {_ext => extensions}/autosectionlabel.py (100%) rename {_ext => extensions}/cps.py (100%) create mode 100644 poetry.lock create mode 100644 pyproject.toml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..cf4d865 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,57 @@ +name: Docs +on: + pull_request: + types: [synchronize, edited, opened] + push: + branches: [main] +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Install Poetry + run: pipx install poetry + - name: Setup Python + uses: actions/setup-python@v5 + with: + cache: poetry + - name: Install Environment + run: poetry install + - name: Build Documentation + run: >- + poetry run sphinx-build + --color + -b html + ${{github.workspace}} + ${{github.workspace}}/_site + - name: Archive Documentation + run: >- + tar + --create + --gzip + --verbose + --mode=a+rw + --file=cps-docs.tar.gz + --directory=${{_site + . + - name: Upload Archive + uses: actions/upload-artifact@v4 + with: + if-no-files-found: error + name: github-pages + path: ${{github.workspace}}/cps-docs.tar.gz + deploy: + if: github.event.repository.default_branch == github.ref_name + needs: build + runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url}} + steps: + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 + id: deployment diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..74cfcc7 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,15 @@ +name: Spellcheck +on: + pull_request: + types: [synchronize, edited, opened] + push: + branches: [main] +jobs: + spellcheck: + name: Spellcheck + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Spellcheck + uses: crate-ci/typos@master diff --git a/conf.py b/conf.py index 946d45e..d2f3d72 100644 --- a/conf.py +++ b/conf.py @@ -20,7 +20,7 @@ copyright = u'2023, Matthew Woehlke' release = '.'.join(map(str, [0, 9, 0])) -version = re.match('\\d+\.\\d+', release).group(0) +version = re.match(r'\d+\.\d+', release).group(0) language = 'en' primary_domain = 'cps' diff --git a/_ext/autosectionlabel.py b/extensions/autosectionlabel.py similarity index 100% rename from _ext/autosectionlabel.py rename to extensions/autosectionlabel.py diff --git a/_ext/cps.py b/extensions/cps.py similarity index 100% rename from _ext/cps.py rename to extensions/cps.py diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 0000000..60ac789 --- /dev/null +++ b/poetry.lock @@ -0,0 +1,474 @@ +# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. + +[[package]] +name = "alabaster" +version = "0.7.16" +description = "A light, configurable Sphinx theme" +optional = false +python-versions = ">=3.9" +files = [ + {file = "alabaster-0.7.16-py3-none-any.whl", hash = "sha256:b46733c07dce03ae4e150330b975c75737fa60f0a7c591b6c8bf4928a28e2c92"}, + {file = "alabaster-0.7.16.tar.gz", hash = "sha256:75a8b99c28a5dad50dd7f8ccdd447a121ddb3892da9e53d1ca5cca3106d58d65"}, +] + +[[package]] +name = "babel" +version = "2.14.0" +description = "Internationalization utilities" +optional = false +python-versions = ">=3.7" +files = [ + {file = "Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287"}, + {file = "Babel-2.14.0.tar.gz", hash = "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363"}, +] + +[package.extras] +dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] + +[[package]] +name = "certifi" +version = "2024.2.2" +description = "Python package for providing Mozilla's CA Bundle." +optional = false +python-versions = ">=3.6" +files = [ + {file = "certifi-2024.2.2-py3-none-any.whl", hash = "sha256:dc383c07b76109f368f6106eee2b593b04a011ea4d55f652c6ca24a754d1cdd1"}, + {file = "certifi-2024.2.2.tar.gz", hash = "sha256:0569859f95fc761b18b45ef421b1290a0f65f147e92a1e5eb3e635f9a5e4e66f"}, +] + +[[package]] +name = "charset-normalizer" +version = "3.3.2" +description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." +optional = false +python-versions = ">=3.7.0" +files = [ + {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, + {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, +] + +[[package]] +name = "colorama" +version = "0.4.6" +description = "Cross-platform colored terminal text." +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +files = [ + {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, + {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, +] + +[[package]] +name = "docutils" +version = "0.20.1" +description = "Docutils -- Python Documentation Utilities" +optional = false +python-versions = ">=3.7" +files = [ + {file = "docutils-0.20.1-py3-none-any.whl", hash = "sha256:96f387a2c5562db4476f09f13bbab2192e764cac08ebbf3a34a95d9b1e4a59d6"}, + {file = "docutils-0.20.1.tar.gz", hash = "sha256:f08a4e276c3a1583a86dce3e34aba3fe04d02bba2dd51ed16106244e8a923e3b"}, +] + +[[package]] +name = "idna" +version = "3.6" +description = "Internationalized Domain Names in Applications (IDNA)" +optional = false +python-versions = ">=3.5" +files = [ + {file = "idna-3.6-py3-none-any.whl", hash = "sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f"}, + {file = "idna-3.6.tar.gz", hash = "sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca"}, +] + +[[package]] +name = "imagesize" +version = "1.4.1" +description = "Getting image size from png/jpeg/jpeg2000/gif file" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +files = [ + {file = "imagesize-1.4.1-py2.py3-none-any.whl", hash = "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b"}, + {file = "imagesize-1.4.1.tar.gz", hash = "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"}, +] + +[[package]] +name = "jinja2" +version = "3.1.3" +description = "A very fast and expressive template engine." +optional = false +python-versions = ">=3.7" +files = [ + {file = "Jinja2-3.1.3-py3-none-any.whl", hash = "sha256:7d6d50dd97d52cbc355597bd845fabfbac3f551e1f99619e39a35ce8c370b5fa"}, + {file = "Jinja2-3.1.3.tar.gz", hash = "sha256:ac8bd6544d4bb2c9792bf3a159e80bba8fda7f07e81bc3aed565432d5925ba90"}, +] + +[package.dependencies] +MarkupSafe = ">=2.0" + +[package.extras] +i18n = ["Babel (>=2.7)"] + +[[package]] +name = "markupsafe" +version = "2.1.5" +description = "Safely add untrusted strings to HTML/XML markup." +optional = false +python-versions = ">=3.7" +files = [ + {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"}, + {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"}, + {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"}, + {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"}, + {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"}, + {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"}, + {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"}, + {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"}, +] + +[[package]] +name = "packaging" +version = "23.2" +description = "Core utilities for Python packages" +optional = false +python-versions = ">=3.7" +files = [ + {file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"}, + {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, +] + +[[package]] +name = "pygments" +version = "2.17.2" +description = "Pygments is a syntax highlighting package written in Python." +optional = false +python-versions = ">=3.7" +files = [ + {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"}, + {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"}, +] + +[package.extras] +plugins = ["importlib-metadata"] +windows-terminal = ["colorama (>=0.4.6)"] + +[[package]] +name = "requests" +version = "2.31.0" +description = "Python HTTP for Humans." +optional = false +python-versions = ">=3.7" +files = [ + {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, + {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, +] + +[package.dependencies] +certifi = ">=2017.4.17" +charset-normalizer = ">=2,<4" +idna = ">=2.5,<4" +urllib3 = ">=1.21.1,<3" + +[package.extras] +socks = ["PySocks (>=1.5.6,!=1.5.7)"] +use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] + +[[package]] +name = "snowballstemmer" +version = "2.2.0" +description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." +optional = false +python-versions = "*" +files = [ + {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"}, + {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"}, +] + +[[package]] +name = "sphinx" +version = "7.2.6" +description = "Python documentation generator" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinx-7.2.6-py3-none-any.whl", hash = "sha256:1e09160a40b956dc623c910118fa636da93bd3ca0b9876a7b3df90f07d691560"}, + {file = "sphinx-7.2.6.tar.gz", hash = "sha256:9a5160e1ea90688d5963ba09a2dcd8bdd526620edbb65c328728f1b2228d5ab5"}, +] + +[package.dependencies] +alabaster = ">=0.7,<0.8" +babel = ">=2.9" +colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} +docutils = ">=0.18.1,<0.21" +imagesize = ">=1.3" +Jinja2 = ">=3.0" +packaging = ">=21.0" +Pygments = ">=2.14" +requests = ">=2.25.0" +snowballstemmer = ">=2.0" +sphinxcontrib-applehelp = "*" +sphinxcontrib-devhelp = "*" +sphinxcontrib-htmlhelp = ">=2.0.0" +sphinxcontrib-jsmath = "*" +sphinxcontrib-qthelp = "*" +sphinxcontrib-serializinghtml = ">=1.1.9" + +[package.extras] +docs = ["sphinxcontrib-websupport"] +lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-simplify", "isort", "mypy (>=0.990)", "ruff", "sphinx-lint", "types-requests"] +test = ["cython (>=3.0)", "filelock", "html5lib", "pytest (>=4.6)", "setuptools (>=67.0)"] + +[[package]] +name = "sphinxcontrib-applehelp" +version = "1.0.8" +description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_applehelp-1.0.8-py3-none-any.whl", hash = "sha256:cb61eb0ec1b61f349e5cc36b2028e9e7ca765be05e49641c97241274753067b4"}, + {file = "sphinxcontrib_applehelp-1.0.8.tar.gz", hash = "sha256:c40a4f96f3776c4393d933412053962fac2b84f4c99a7982ba42e09576a70619"}, +] + +[package.extras] +lint = ["docutils-stubs", "flake8", "mypy"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-devhelp" +version = "1.0.6" +description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_devhelp-1.0.6-py3-none-any.whl", hash = "sha256:6485d09629944511c893fa11355bda18b742b83a2b181f9a009f7e500595c90f"}, + {file = "sphinxcontrib_devhelp-1.0.6.tar.gz", hash = "sha256:9893fd3f90506bc4b97bdb977ceb8fbd823989f4316b28c3841ec128544372d3"}, +] + +[package.extras] +lint = ["docutils-stubs", "flake8", "mypy"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-htmlhelp" +version = "2.0.5" +description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl", hash = "sha256:393f04f112b4d2f53d93448d4bce35842f62b307ccdc549ec1585e950bc35e04"}, + {file = "sphinxcontrib_htmlhelp-2.0.5.tar.gz", hash = "sha256:0dc87637d5de53dd5eec3a6a01753b1ccf99494bd756aafecd74b4fa9e729015"}, +] + +[package.extras] +lint = ["docutils-stubs", "flake8", "mypy"] +standalone = ["Sphinx (>=5)"] +test = ["html5lib", "pytest"] + +[[package]] +name = "sphinxcontrib-jsmath" +version = "1.0.1" +description = "A sphinx extension which renders display math in HTML via JavaScript" +optional = false +python-versions = ">=3.5" +files = [ + {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, + {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, +] + +[package.extras] +test = ["flake8", "mypy", "pytest"] + +[[package]] +name = "sphinxcontrib-qthelp" +version = "1.0.7" +description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_qthelp-1.0.7-py3-none-any.whl", hash = "sha256:e2ae3b5c492d58fcbd73281fbd27e34b8393ec34a073c792642cd8e529288182"}, + {file = "sphinxcontrib_qthelp-1.0.7.tar.gz", hash = "sha256:053dedc38823a80a7209a80860b16b722e9e0209e32fea98c90e4e6624588ed6"}, +] + +[package.extras] +lint = ["docutils-stubs", "flake8", "mypy"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-serializinghtml" +version = "1.1.10" +description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl", hash = "sha256:326369b8df80a7d2d8d7f99aa5ac577f51ea51556ed974e7716cfd4fca3f6cb7"}, + {file = "sphinxcontrib_serializinghtml-1.1.10.tar.gz", hash = "sha256:93f3f5dc458b91b192fe10c397e324f262cf163d79f3282c158e8436a2c4511f"}, +] + +[package.extras] +lint = ["docutils-stubs", "flake8", "mypy"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + +[[package]] +name = "urllib3" +version = "2.2.1" +description = "HTTP library with thread-safe connection pooling, file post, and more." +optional = false +python-versions = ">=3.8" +files = [ + {file = "urllib3-2.2.1-py3-none-any.whl", hash = "sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d"}, + {file = "urllib3-2.2.1.tar.gz", hash = "sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19"}, +] + +[package.extras] +brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"] +h2 = ["h2 (>=4,<5)"] +socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] +zstd = ["zstandard (>=0.18.0)"] + +[metadata] +lock-version = "2.0" +python-versions = "^3.10" +content-hash = "2142cfbe5cdc992a60d38a938719f8e1c328b2bb3e05808e3f893f738aad7382" diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a1626c6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,28 @@ +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" + +[tool.poetry] +name = "cps" +version = "0.dev" +description = "" +authors = ["The CPS Project <@>"] +readme = "README.md" +packages = [ + { include = "cps.py", from = "extensions" }, + { include = "autosectionlabel.py", from = "extensions" } +] + +[tool.poetry.dependencies] +python = "^3.10" + +[tool.poetry.group.docs.dependencies] +python = "^3.10" +sphinx = ">=7.2.6" + +[tool.poetry.plugins."sphinx.builders"] +cps = "cps" +autosectionlabel = "autosectionlabel" + +[tool.typos] +files.extend-exclude = ["*.css", "*.svg"] From f01a878fce34086e0c5e5288f0c5411b8c6c1737 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Wed, 28 Feb 2024 13:19:42 -0800 Subject: [PATCH 02/21] =?UTF-8?q?=F0=9F=92=9A=20Fix=20missing=20`--with`?= =?UTF-8?q?=20for=20poetry=20dependency=20group?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index cf4d865..384995b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,7 +17,7 @@ jobs: with: cache: poetry - name: Install Environment - run: poetry install + run: poetry install --with=docs - name: Build Documentation run: >- poetry run sphinx-build From 0fe216dd1356d9eadb9c2100fe523c8024104b5c Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Wed, 28 Feb 2024 16:45:58 -0800 Subject: [PATCH 03/21] =?UTF-8?q?=F0=9F=9A=9A=20Perform=20some=20slight=20?= =?UTF-8?q?build=20suggestions=20to=20be=20more=20uniform=20with=20the=20b?= =?UTF-8?q?uild.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 2 +- {extensions => _extensions}/autosectionlabel.py | 0 {extensions => _extensions}/cps.py | 0 publish.sh | 2 +- pyproject.toml | 4 ++-- 5 files changed, 4 insertions(+), 4 deletions(-) rename {extensions => _extensions}/autosectionlabel.py (100%) rename {extensions => _extensions}/cps.py (100%) diff --git a/Makefile b/Makefile index d18d1e2..0a62118 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -BUILDDIR = site +BUILDDIR = _site # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) diff --git a/extensions/autosectionlabel.py b/_extensions/autosectionlabel.py similarity index 100% rename from extensions/autosectionlabel.py rename to _extensions/autosectionlabel.py diff --git a/extensions/cps.py b/_extensions/cps.py similarity index 100% rename from extensions/cps.py rename to _extensions/cps.py diff --git a/publish.sh b/publish.sh index 5bf301a..8501c1c 100755 --- a/publish.sh +++ b/publish.sh @@ -1,6 +1,6 @@ #!/bin/sh -e -cd site +cd _site git diff-index --quiet HEAD -- && exit 0 git add . diff --git a/pyproject.toml b/pyproject.toml index a1626c6..f624e7a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,8 +9,8 @@ description = "" authors = ["The CPS Project <@>"] readme = "README.md" packages = [ - { include = "cps.py", from = "extensions" }, - { include = "autosectionlabel.py", from = "extensions" } + { include = "cps.py", from = "_extensions" }, + { include = "autosectionlabel.py", from = "_extensions" } ] [tool.poetry.dependencies] From 8b6a08bad8f16c676fa20414bc473bb6638566db Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Thu, 29 Feb 2024 11:46:36 -0800 Subject: [PATCH 04/21] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Fix=20a=20few=20typo?= =?UTF-8?q?s=20and=20suggestions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 4 ++-- pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 384995b..81181a7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: --verbose --mode=a+rw --file=cps-docs.tar.gz - --directory=${{_site + --directory=${{_site}} . - name: Upload Archive uses: actions/upload-artifact@v4 @@ -50,7 +50,7 @@ jobs: id-token: write environment: name: github-pages - url: ${{ steps.deployment.outputs.page_url}} + url: ${{steps.deployment.outputs.page_url}} steps: - name: Deploy to GitHub Pages uses: actions/deploy-pages@v4 diff --git a/pyproject.toml b/pyproject.toml index f624e7a..72b931f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ python = "^3.10" [tool.poetry.group.docs.dependencies] python = "^3.10" -sphinx = ">=7.2.6" +sphinx = "<=7.2.6" [tool.poetry.plugins."sphinx.builders"] cps = "cps" From 0a48e567decdeb05e8e59dbdec2732b7227a4a48 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Thu, 29 Feb 2024 11:51:57 -0800 Subject: [PATCH 05/21] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20Upgrade=20minimum=20?= =?UTF-8?q?sphinx=20version=20to=206.2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🔥 Obliterate `sys.path.insert` change --- conf.py | 11 ++++------- pyproject.toml | 2 +- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/conf.py b/conf.py index d2f3d72..7c7f84e 100644 --- a/conf.py +++ b/conf.py @@ -4,10 +4,8 @@ import re import sys -sys.path.insert(0, os.path.abspath('_ext')) - # -- General configuration ------------------------------------------------ -needs_sphinx = '5.3' +needs_sphinx = '6.2' extensions = ['cps', 'autosectionlabel'] source_suffix = '.rst' @@ -16,11 +14,10 @@ master_doc = 'index' # General information about the project. -project = u'Common Package Specification' -copyright = u'2023, Matthew Woehlke' +project = 'Common Package Specification' +copyright = '2023, Matthew Woehlke' -release = '.'.join(map(str, [0, 9, 0])) -version = re.match(r'\d+\.\d+', release).group(0) +release = version = "0.9.0" language = 'en' primary_domain = 'cps' diff --git a/pyproject.toml b/pyproject.toml index 72b931f..4b3339b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ python = "^3.10" [tool.poetry.group.docs.dependencies] python = "^3.10" -sphinx = "<=7.2.6" +sphinx = ">=6.2,<7.3" [tool.poetry.plugins."sphinx.builders"] cps = "cps" From 3fb4c18f166dbdf67648049688d96fa570e68e51 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Thu, 29 Feb 2024 11:53:20 -0800 Subject: [PATCH 06/21] =?UTF-8?q?=F0=9F=94=92=EF=B8=8F=20Update=20poetry.l?= =?UTF-8?q?ock=20versioning?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- poetry.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/poetry.lock b/poetry.lock index 60ac789..4518dfc 100644 --- a/poetry.lock +++ b/poetry.lock @@ -471,4 +471,4 @@ zstd = ["zstandard (>=0.18.0)"] [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "2142cfbe5cdc992a60d38a938719f8e1c328b2bb3e05808e3f893f738aad7382" +content-hash = "fde3dad647b4b6f76ddda0c1494db2f526f4355ad1678f9d8a881178e63510c7" From 086e6bc30695b01a4f9320ca18d40834dce4e5ce Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Fri, 1 Mar 2024 23:57:33 -0800 Subject: [PATCH 07/21] =?UTF-8?q?=F0=9F=92=9A=20Fix=20incorrect=20`--direc?= =?UTF-8?q?tory`=20for=20`tar`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 81181a7..fa2a6c7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: --verbose --mode=a+rw --file=cps-docs.tar.gz - --directory=${{_site}} + --directory=${{github.workspace}}/_site . - name: Upload Archive uses: actions/upload-artifact@v4 From 608ecee3e049bd38b5b9c78109b4367feb79c8f3 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Sun, 17 Mar 2024 13:18:01 -0700 Subject: [PATCH 08/21] =?UTF-8?q?=F0=9F=94=A5=20Remove=20spellcheck.yml=20?= =?UTF-8?q?per=20feedback?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ✏️ Change branch name from `main` to `master` per feedback --- .github/workflows/docs.yml | 2 +- .github/workflows/spellcheck.yml | 15 --------------- 2 files changed, 1 insertion(+), 16 deletions(-) delete mode 100644 .github/workflows/spellcheck.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fa2a6c7..2bc5ea8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,7 @@ on: pull_request: types: [synchronize, edited, opened] push: - branches: [main] + branches: [master] jobs: build: runs-on: ubuntu-latest diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml deleted file mode 100644 index 74cfcc7..0000000 --- a/.github/workflows/spellcheck.yml +++ /dev/null @@ -1,15 +0,0 @@ -name: Spellcheck -on: - pull_request: - types: [synchronize, edited, opened] - push: - branches: [main] -jobs: - spellcheck: - name: Spellcheck - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Spellcheck - uses: crate-ci/typos@master From 1a5745a74cfde856d0488342a455b4ca2a9aa503 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Sun, 17 Mar 2024 15:04:07 -0700 Subject: [PATCH 09/21] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Change=20Makefile=20?= =?UTF-8?q?to=20use=20poetry=20+=20work=20on=20windows=20(with=20the=20exc?= =?UTF-8?q?eption=20of=20the=20publish=20target)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 3 ++- Makefile | 53 +++++++++++++++++++++++++++++++++++++---------------- 2 files changed, 39 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 2bfdaa8..e7db7eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +/_site/ /site/ -/_ext/__pycache__/ +__pycache__ diff --git a/Makefile b/Makefile index 0a62118..6d008d2 100644 --- a/Makefile +++ b/Makefile @@ -1,27 +1,48 @@ -# Makefile for Sphinx documentation +GNUMAKEFLAGS := --no-builtins --no-builtin-variables +.SUFFIXES: -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -BUILDDIR = _site +ifeq ($(OS),Windows_NT) +--which := where +--null := nul +RM := rmdir /s /q +else +--which := which +--null ?= /dev/null +RM := rm -rf +endif + +POETRY ?= $(shell $(--which) poetry 2> $(--null)) -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +ifeq (${POETRY},) +$(error Could not find the `poetry` command. \ + Please make sure you have installed poetry, and that it is on your system's PATH environment variable. \ + If you don't have poetry installed, please visit https://python-poetry.org for instructions on its installation.) endif -.PHONY: clean all +venv ?= $(shell $(POETRY) env info --path 2> $(--null)) -all: - $(SPHINXBUILD) -b html $(SPHINXOPTS) . $(BUILDDIR) - @echo - @echo "Build finished. The HTML pages are in '$(BUILDDIR)'." +srcdir := $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) -clean: - rm -rf $(BUILDDIR)/* +build.flags += $(if $(BUILDER),-b $(BUILDER),-b html) +build.flags += $(if $(NOCOLOR),,--color) +build.flags += $(if $(SPHINXOPTS),$(SPHINXOPTS)) + +SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) +OUTDIR ?= $(join $(SRCDIR),_site) + +.PHONY: all setup cache-clean clean + +all: $(if $(venv),,setup) + $(POETRY) run sphinx-build ${build.flags} "${SRCDIR}" "${OUTDIR}" cache-clean: - rm -rf $(BUILDDIR)/.doctrees + $(RM) "$(join $(OUTDIR),.doctrees)" + +clean: + $(RM) "$(OUTDIR)" + +setup: + $(POETRY) install publish: clean all ./publish.sh From a3cf6be818a5a1ffe14c448a36957e8d3238bdcb Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 11:46:44 -0700 Subject: [PATCH 10/21] =?UTF-8?q?=F0=9F=90=9B=20Fix=20readme.md=20vs=20REA?= =?UTF-8?q?DME.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 4b3339b..d66bd6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ name = "cps" version = "0.dev" description = "" authors = ["The CPS Project <@>"] -readme = "README.md" +readme = "readme.md" packages = [ { include = "cps.py", from = "_extensions" }, { include = "autosectionlabel.py", from = "_extensions" } From ad9922bae9e34fd364a06111f4258cac900fb405 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:04:52 -0700 Subject: [PATCH 11/21] =?UTF-8?q?=F0=9F=94=A8=20Slight=20changes=20to=20bu?= =?UTF-8?q?ild=20targets=20+=20execution?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 2 ++ Makefile | 19 ++++++++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2bc5ea8..61e1189 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,6 +16,8 @@ jobs: uses: actions/setup-python@v5 with: cache: poetry + - name: Validate pyproject.toml + run: poetry check - name: Install Environment run: poetry install --with=docs - name: Build Documentation diff --git a/Makefile b/Makefile index 6d008d2..75372cf 100644 --- a/Makefile +++ b/Makefile @@ -13,15 +13,14 @@ endif POETRY ?= $(shell $(--which) poetry 2> $(--null)) -ifeq (${POETRY},) +ifeq ($(POETRY),) $(error Could not find the `poetry` command. \ Please make sure you have installed poetry, and that it is on your system's PATH environment variable. \ If you don't have poetry installed, please visit https://python-poetry.org for instructions on its installation.) endif -venv ?= $(shell $(POETRY) env info --path 2> $(--null)) - srcdir := $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) +venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null)))) build.flags += $(if $(BUILDER),-b $(BUILDER),-b html) build.flags += $(if $(NOCOLOR),,--color) @@ -30,19 +29,25 @@ build.flags += $(if $(SPHINXOPTS),$(SPHINXOPTS)) SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) OUTDIR ?= $(join $(SRCDIR),_site) -.PHONY: all setup cache-clean clean +.PHONY: all setup cache-clean clean clean.venv purge -all: $(if $(venv),,setup) +all: setup $(POETRY) run sphinx-build ${build.flags} "${SRCDIR}" "${OUTDIR}" -cache-clean: +clean.cache: $(RM) "$(join $(OUTDIR),.doctrees)" +clean.venv: + $(POETRY) env remove "${venv}" + clean: $(RM) "$(OUTDIR)" +purge: clean.venv clean + setup: - $(POETRY) install + @$(POETRY) check + @$(POETRY) install publish: clean all ./publish.sh From 6a6792d69e6022e529c991aa5cefab5d9e8da812 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:11:44 -0700 Subject: [PATCH 12/21] =?UTF-8?q?=F0=9F=93=84=20Update=20Makefile=20error?= =?UTF-8?q?=20message?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthew Woehlke --- Makefile | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 75372cf..08b1ad3 100644 --- a/Makefile +++ b/Makefile @@ -15,8 +15,11 @@ POETRY ?= $(shell $(--which) poetry 2> $(--null)) ifeq ($(POETRY),) $(error Could not find the `poetry` command. \ - Please make sure you have installed poetry, and that it is on your system's PATH environment variable. \ - If you don't have poetry installed, please visit https://python-poetry.org for instructions on its installation.) + Please make sure you have installed poetry, \ + and that it is on your system's PATH environment variable. \ + If you don't have poetry installed, \ + please visit https://python-poetry.org \ + for instructions on its installation) endif srcdir := $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) From 10bde4e91f27e4ff8fe1bdb42816e25cb4311c9f Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:14:34 -0700 Subject: [PATCH 13/21] =?UTF-8?q?=F0=9F=99=88=20Update=20.gitignore?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthew Woehlke --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index e7db7eb..c41ea03 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ /_site/ -/site/ __pycache__ From 1cc85392df80ced5b71c73c7c08814cf130d9c3b Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:14:59 -0700 Subject: [PATCH 14/21] =?UTF-8?q?=F0=9F=99=88=20Update=20.gitignore?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthew Woehlke --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c41ea03..ce62547 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ /_site/ -__pycache__ +__pycache__/ From 061166fc15425f010e8ac889b03582c72834c967 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:15:28 -0700 Subject: [PATCH 15/21] =?UTF-8?q?=F0=9F=94=A7=20Update=20pyproject.toml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthew Woehlke --- pyproject.toml | 3 --- 1 file changed, 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index d66bd6e..2946648 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,6 +23,3 @@ sphinx = ">=6.2,<7.3" [tool.poetry.plugins."sphinx.builders"] cps = "cps" autosectionlabel = "autosectionlabel" - -[tool.typos] -files.extend-exclude = ["*.css", "*.svg"] From f48af8b38eb06be4c4f54c73a5194f0e7db56d0a Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Mon, 18 Mar 2024 22:29:32 -0700 Subject: [PATCH 16/21] =?UTF-8?q?=F0=9F=91=B7=20Properly=20enable=20the=20?= =?UTF-8?q?cache=20with=20`python-version:=20'3.x'`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 61e1189..ca08a99 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,6 +15,7 @@ jobs: - name: Setup Python uses: actions/setup-python@v5 with: + python-version: '3.x' cache: poetry - name: Validate pyproject.toml run: poetry check From 6d899a50e57925bf18cf0e74539babbbc8ea6f85 Mon Sep 17 00:00:00 2001 From: Matthew Woehlke Date: Tue, 19 Mar 2024 13:31:21 -0400 Subject: [PATCH 17/21] Clean up Fix some minor issues in Makefile (list of phony targets was wrong, `setup` was missing `--with=docs`, unused variable, still using braces in one line) and rearrange targets in roughly order-of-use. Use `make` to drive CI actions rather than duplicating commands. --- .github/workflows/docs.yml | 11 ++--------- Makefile | 25 ++++++++++++++----------- 2 files changed, 16 insertions(+), 20 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ca08a99..6b97cfe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,17 +17,10 @@ jobs: with: python-version: '3.x' cache: poetry - - name: Validate pyproject.toml - run: poetry check - name: Install Environment - run: poetry install --with=docs + run: make setup - name: Build Documentation - run: >- - poetry run sphinx-build - --color - -b html - ${{github.workspace}} - ${{github.workspace}}/_site + run: make html - name: Archive Documentation run: >- tar diff --git a/Makefile b/Makefile index 08b1ad3..a76e6af 100644 --- a/Makefile +++ b/Makefile @@ -22,9 +22,10 @@ $(error Could not find the `poetry` command. \ for instructions on its installation) endif -srcdir := $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null)))) +setup.flags += --with=docs + build.flags += $(if $(BUILDER),-b $(BUILDER),-b html) build.flags += $(if $(NOCOLOR),,--color) build.flags += $(if $(SPHINXOPTS),$(SPHINXOPTS)) @@ -32,25 +33,27 @@ build.flags += $(if $(SPHINXOPTS),$(SPHINXOPTS)) SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) OUTDIR ?= $(join $(SRCDIR),_site) -.PHONY: all setup cache-clean clean clean.venv purge +.PHONY: all setup html clean.venv clean.cache clean purge publish -all: setup - $(POETRY) run sphinx-build ${build.flags} "${SRCDIR}" "${OUTDIR}" +all: html -clean.cache: - $(RM) "$(join $(OUTDIR),.doctrees)" +setup: + $(POETRY) check + $(POETRY) install $(setup.flags) + +html: setup + $(POETRY) run sphinx-build $(build.flags) "$(SRCDIR)" "$(OUTDIR)" clean.venv: - $(POETRY) env remove "${venv}" + $(if $(venv),$(POETRY) env remove "$(venv)",@echo "Nothing to do") + +clean.cache: + $(RM) "$(join $(OUTDIR),.doctrees)" clean: $(RM) "$(OUTDIR)" purge: clean.venv clean -setup: - @$(POETRY) check - @$(POETRY) install - publish: clean all ./publish.sh From d992f0dbd34fea0e08e181d8c6b8fef22807d549 Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Tue, 19 Mar 2024 11:15:39 -0700 Subject: [PATCH 18/21] =?UTF-8?q?=F0=9F=91=B7=20Reuse=20make=20for=20more?= =?UTF-8?q?=20docs=20workflow=20operations.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 10 +--------- Makefile | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6b97cfe..1f2a2b6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,15 +22,7 @@ jobs: - name: Build Documentation run: make html - name: Archive Documentation - run: >- - tar - --create - --gzip - --verbose - --mode=a+rw - --file=cps-docs.tar.gz - --directory=${{github.workspace}}/_site - . + run: make archive - name: Upload Archive uses: actions/upload-artifact@v4 with: diff --git a/Makefile b/Makefile index a76e6af..d05cafe 100644 --- a/Makefile +++ b/Makefile @@ -22,18 +22,25 @@ $(error Could not find the `poetry` command. \ for instructions on its installation) endif +SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) +OUTDIR ?= $(join $(SRCDIR),_site) + venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null)))) +archive.flags += --create --gzip --verbose +archive.flags += --file=$(if $(ARCHIVE),$(ARCHIVE),cps-docs).tar.gz +archive.flags += --directory=$(OUTDIR) +ifneq ($(OS),Windows_NT) +archive.flags += --mode=a+rw +endif + setup.flags += --with=docs build.flags += $(if $(BUILDER),-b $(BUILDER),-b html) build.flags += $(if $(NOCOLOR),,--color) build.flags += $(if $(SPHINXOPTS),$(SPHINXOPTS)) -SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) -OUTDIR ?= $(join $(SRCDIR),_site) - -.PHONY: all setup html clean.venv clean.cache clean purge publish +.PHONY: all setup html clean.venv clean.cache clean purge archive publish all: html @@ -55,5 +62,8 @@ clean: purge: clean.venv clean +archive: html + tar $(archive.flags) . + publish: clean all ./publish.sh From 347178b6e25d38d91dc1bf178adfb5a34309729c Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Tue, 19 Mar 2024 11:31:30 -0700 Subject: [PATCH 19/21] =?UTF-8?q?=F0=9F=9B=A0=20Update=20Makefile?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthew Woehlke --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index d05cafe..edb8bd9 100644 --- a/Makefile +++ b/Makefile @@ -28,7 +28,7 @@ OUTDIR ?= $(join $(SRCDIR),_site) venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null)))) archive.flags += --create --gzip --verbose -archive.flags += --file=$(if $(ARCHIVE),$(ARCHIVE),cps-docs).tar.gz +archive.flags += --file=$(if $(ARCHIVE),$(ARCHIVE),cps-docs.tar.gz) archive.flags += --directory=$(OUTDIR) ifneq ($(OS),Windows_NT) archive.flags += --mode=a+rw From daa807a17afd8574e5d3d873dd1122ca3bc50ba6 Mon Sep 17 00:00:00 2001 From: Matthew Woehlke Date: Tue, 19 Mar 2024 14:36:40 -0400 Subject: [PATCH 20/21] Slightly simplify Makefile --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index edb8bd9..c252935 100644 --- a/Makefile +++ b/Makefile @@ -24,11 +24,12 @@ endif SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) OUTDIR ?= $(join $(SRCDIR),_site) +ARCHIVE ?= cps-docs.tar.gz venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null)))) archive.flags += --create --gzip --verbose -archive.flags += --file=$(if $(ARCHIVE),$(ARCHIVE),cps-docs.tar.gz) +archive.flags += --file=$(ARCHIVE) archive.flags += --directory=$(OUTDIR) ifneq ($(OS),Windows_NT) archive.flags += --mode=a+rw From 3aadb7c5c3c8ecebad872a59781aedefea91087f Mon Sep 17 00:00:00 2001 From: Izzy Muerte <63051+bruxisma@users.noreply.github.com> Date: Tue, 19 Mar 2024 11:42:01 -0700 Subject: [PATCH 21/21] =?UTF-8?q?=F0=9F=94=A8=20Simplify=20Makefile=20furt?= =?UTF-8?q?her=20:P?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index c252935..a8ff939 100644 --- a/Makefile +++ b/Makefile @@ -25,6 +25,7 @@ endif SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) OUTDIR ?= $(join $(SRCDIR),_site) ARCHIVE ?= cps-docs.tar.gz +SPHINXOPTS ?= venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null)))) @@ -39,7 +40,7 @@ setup.flags += --with=docs build.flags += $(if $(BUILDER),-b $(BUILDER),-b html) build.flags += $(if $(NOCOLOR),,--color) -build.flags += $(if $(SPHINXOPTS),$(SPHINXOPTS)) +build.flags += $(SPHINXOPTS) .PHONY: all setup html clean.venv clean.cache clean purge archive publish