diff --git a/.cspell.json b/.cspell.json index f81e969..09ee88e 100644 --- a/.cspell.json +++ b/.cspell.json @@ -1,4 +1,5 @@ { + "language": "en", "dictionaries": [ "aws", "bash", @@ -7,25 +8,7 @@ "misc", "softwareTerms" ], - "ignorePaths": [ - "__pycache__", - ".DS_Store", - ".git", - ".gitignore", - ".husky", - ".mypy_cache", - ".pytest_cache", - ".thx", - ".yarn", - "*.egg-info", - "coverage", - "dist", - "docs/*.css", - "node_modules", - "venv", - "yarn-error.log" - ], - "language": "en", + "ignorePaths": [".git"], "words": [ "autoapi", "autoflake", @@ -38,11 +21,11 @@ "cppclean", "cppdefines", "cpppath", + "cpppaths", "cxxcomstr", "cxxflags", "debugpy", "doctest", - "doxyfile", "emojize", "furo", "giphy", @@ -50,10 +33,9 @@ "gtest", "isort", "lefkowitz", + "libpaths", "linkcomstr", - "mainpage", "matplotlib", - "mdfile", "miniscons", "mypy", "opengraph", @@ -66,16 +48,13 @@ "pytest", "scons", "sdist", - "searchengine", "searchindex", "sphinxext", - "stylesheet", "toctree", - "treeview", "trufflehog", "undoc", "venv", - "walkmate", - "werror" + "werror", + "walkmate" ] } diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f27addd..690e1fb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout the source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Install dependencies uses: ./.github/actions/install diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index d7f7a42..0000000 --- a/.prettierignore +++ /dev/null @@ -1 +0,0 @@ -.mypy_cache diff --git a/README.md b/README.md index ec7b07b..a1ac3ee 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ SCons builders. ![Quality](https://img.shields.io/codacy/grade/97f4a968fe554186b58c2f49903a09f4) ![Coverage](https://img.shields.io/codacy/coverage/97f4a968fe554186b58c2f49903a09f4) - ## Motivation When writing an `SConstruct.py` configuration it is difficult to: @@ -136,7 +135,7 @@ if GetOption("dump"): Now if we run -```sh +```bash scons --dump ``` @@ -172,6 +171,14 @@ Some scripts need access to the include paths that appear in the `SConstruct.py` ## Tooling +### Dependencies + +To install dependencies: + +```bash +pip install .[all] +``` + ### Tests To run tests: @@ -224,8 +231,8 @@ bump2version patch Lots of love to the open source community! -
+