diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml index 072ed4b..bb3c32a 100644 --- a/.github/workflows/test-docs.yml +++ b/.github/workflows/test-docs.yml @@ -46,22 +46,10 @@ jobs: - name: Install tox run: python -m pip install --upgrade tox - - name: Set up Homebrew - if: runner.os == 'macOS' - uses: Homebrew/actions/setup-homebrew@master - - - name: Install enchant on macOS - if: runner.os == 'macOS' - run: | - brew update - brew install enchant - - - name: Run tests with tox except linkcheck + - name: Run tests with tox except linkcheck and spelling if: runner.os != 'Linux' run: tox -m docs - env: - TOX_SKIP_ENV: docs-test-linkcheck - name: Run all tests with tox if: runner.os == 'Linux' - run: tox -m docs + run: tox -m docs-full diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7510b43..99c9c1e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -68,7 +68,7 @@ repos: # black - python formatter - repo: https://github.com/psf/black - rev: 6fdf8a4af28071ed1d079c01122b34c5d587207a # frozen: 24.2.0 + rev: 552baf822992936134cbd31a38f69c8cfe7c0f05 # frozen: 24.3.0 hooks: - id: black args: ["--safe"] @@ -212,7 +212,7 @@ repos: # poetry - python dependency management - repo: https://github.com/Cielquan/mirrors-poetry - rev: 41ef89aac1c244b9592952e5624689909ddadbb7 # frozen: 1.7.1 + rev: ec25c4d5817d8bcf1d6251c347a1892cb817edb8 # frozen: 1.8.2 hooks: - id: poetry-check diff --git a/docs/source/api.rst b/docs/source/api.rst index 2456e91..2407337 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -2,12 +2,6 @@ API === -.. spelling:word-list:: - - apidoc - autoapidoc - sphinxcontrib - This part of the documentation covers the open API for this library and is auto generated by sphinx-apidoc via sphinxcontrib-apidoc. diff --git a/docs/source/conf.py b/docs/source/conf.py index ee9e374..3611091 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -164,7 +164,7 @@ def _remove_module_docstring( # pylint: disable=R0913 spelling_show_suggestions = True spelling_exclude_patterns = ["autoapi/**", "autoapidoc/**"] -if find_spec("sphinxcontrib.spelling") is not None: +if find_spec("sphinxcontrib.spelling") is not None and os.environ.get("SPHINX_SPELLING") == "true": extensions.append("sphinxcontrib.spelling") else: NOT_LOADED_MSGS.append("## 'sphinxcontrib-spelling' extension not loaded - not installed") diff --git a/docs/source/contribution/development.rst b/docs/source/contribution/development.rst index 4764010..045f7bf 100644 --- a/docs/source/contribution/development.rst +++ b/docs/source/contribution/development.rst @@ -1,7 +1,3 @@ -.. spelling:word-list:: - - virtualenvs - Development =========== diff --git a/docs/source/contribution/git_workflow.rst b/docs/source/contribution/git_workflow.rst index 977c1c9..2a60aec 100644 --- a/docs/source/contribution/git_workflow.rst +++ b/docs/source/contribution/git_workflow.rst @@ -1,8 +1,3 @@ -.. spelling:word-list:: - - Bugfixes - bugfixes - Git(hub) Workflow ================= diff --git a/docs/source/spelling_dict.txt b/docs/source/spelling_dict.txt index 9b26f75..393132a 100644 --- a/docs/source/spelling_dict.txt +++ b/docs/source/spelling_dict.txt @@ -1,8 +1,10 @@ api +apidoc arg args attr +autoapidoc bool boolean bugfixes @@ -71,6 +73,7 @@ rtd sdist sds setter +sphinxcontrib st strcalc submodule @@ -89,5 +92,6 @@ venv venv's venv_runner virtualenv +virtualenvs xml yaml diff --git a/tox.ini b/tox.ini index 68651f2..bad4a2d 100644 --- a/tox.ini +++ b/tox.ini @@ -19,7 +19,8 @@ labels = py3.9 = py39,coverage-all py3.10 = py310,coverage-all py3.11 = py311,coverage-all - docs = docs-test-{html,linkcheck,coverage,doctest,spelling} + docs = docs-test-{html,coverage,doctest} + docs-full = docs-test-{html,linkcheck,coverage,doctest,spelling} [testenv] @@ -193,6 +194,7 @@ set_env = coverage: TOXENV_BUILDER = coverage doctest: TOXENV_BUILDER = doctest spelling: TOXENV_BUILDER = spelling + spelling: SPHINX_SPELLING = true extras = {[testenv:docs]extras} commands = sphinx-build \