fix(docs): Add docs group to install (#3436)

2026-02-10 06:45:08 +00:00 · 2024-02-26 11:11:31 +01:00
parent 9663ee6062
commit 444ea22b8d
4 changed files with 25 additions and 28 deletions
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -17,7 +17,7 @@ build:
      # Tell poetry to not use a virtual environment
      - poetry config virtualenvs.create false
    post_install:
-      - poetry install -E docs
+      - poetry install --only=docs

 mkdocs:
  configuration: mkdocs.yml
--- a/docs/tutorials/aws/securityhub.md
+++ b/docs/tutorials/aws/securityhub.md
@@ -115,7 +115,8 @@ When you are auditing a multi-account AWS environment, you can send findings to
 prowler --security-hub --role arn:aws:iam::123456789012:role/ProwlerExecutionRole
 ```

-> Remember that the used role needs to have permissions to send findings to Security Hub. To get more information about the permissions required, please refer to the following IAM policy [prowler-security-hub.json](https://github.com/prowler-cloud/prowler/blob/master/permissions/prowler-security-hub.json)
+???+ note
+    Remember that the used role needs to have permissions to send findings to Security Hub. To get more information about the permissions required, please refer to the following IAM policy [prowler-security-hub.json](https://github.com/prowler-cloud/prowler/blob/master/permissions/prowler-security-hub.json)


 ## Send only failed findings to Security Hub
--- a/poetry.lock
+++ b/poetry.lock
@@ -524,7 +524,7 @@ aio = ["azure-core[aio] (>=1.28.0,<2.0.0)"]
 name = "babel"
 version = "2.14.0"
 description = "Internationalization utilities"
-optional = true
+optional = false
 python-versions = ">=3.7"
 files = [
    {file = "Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287"},
@@ -1280,7 +1280,7 @@ files = [
 name = "ghp-import"
 version = "2.1.0"
 description = "Copy your docs directly to the gh-pages branch."
-optional = true
+optional = false
 python-versions = "*"
 files = [
    {file = "ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343"},
@@ -1297,7 +1297,7 @@ dev = ["flake8", "markdown", "twine", "wheel"]
 name = "gitdb"
 version = "4.0.11"
 description = "Git Object Database"
-optional = true
+optional = false
 python-versions = ">=3.7"
 files = [
    {file = "gitdb-4.0.11-py3-none-any.whl", hash = "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4"},
@@ -1311,7 +1311,7 @@ smmap = ">=3.0.1,<6"
 name = "gitpython"
 version = "3.1.42"
 description = "GitPython is a Python library used to interact with Git repositories"
-optional = true
+optional = false
 python-versions = ">=3.7"
 files = [
    {file = "GitPython-3.1.42-py3-none-any.whl", hash = "sha256:1bf9cd7c9e7255f77778ea54359e54ac22a72a5b51288c457c881057b7bb9ecd"},
@@ -1849,7 +1849,7 @@ files = [
 name = "markdown"
 version = "3.5.2"
 description = "Python implementation of John Gruber's Markdown."
-optional = true
+optional = false
 python-versions = ">=3.8"
 files = [
    {file = "Markdown-3.5.2-py3-none-any.whl", hash = "sha256:d43323865d89fc0cb9b20c75fc8ad313af307cc087e84b657d9eec768eddeadd"},
@@ -2002,7 +2002,7 @@ files = [
 name = "mergedeep"
 version = "1.3.4"
 description = "A deep merge function for 🐍."
-optional = true
+optional = false
 python-versions = ">=3.6"
 files = [
    {file = "mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"},
@@ -2094,7 +2094,7 @@ python-dateutil = ">=2.8.2"
 name = "mkdocs"
 version = "1.5.3"
 description = "Project documentation with Markdown."
-optional = true
+optional = false
 python-versions = ">=3.7"
 files = [
    {file = "mkdocs-1.5.3-py3-none-any.whl", hash = "sha256:3b3a78e736b31158d64dbb2f8ba29bd46a379d0c6e324c2246c3bc3d2189cfc1"},
@@ -2125,7 +2125,7 @@ min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-imp
 name = "mkdocs-git-revision-date-localized-plugin"
 version = "1.2.4"
 description = "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file."
-optional = true
+optional = false
 python-versions = ">=3.8"
 files = [
    {file = "mkdocs-git-revision-date-localized-plugin-1.2.4.tar.gz", hash = "sha256:08fd0c6f33c8da9e00daf40f7865943113b3879a1c621b2bbf0fa794ffe997d3"},
@@ -2142,7 +2142,7 @@ pytz = "*"
 name = "mkdocs-material"
 version = "9.5.10"
 description = "Documentation that simply works"
-optional = true
+optional = false
 python-versions = ">=3.8"
 files = [
    {file = "mkdocs_material-9.5.10-py3-none-any.whl", hash = "sha256:3c6c46b57d2ee3c8890e6e0406e68b6863cf65768f0f436990a742702d198442"},
@@ -2171,7 +2171,7 @@ recommended = ["mkdocs-minify-plugin (>=0.7,<1.0)", "mkdocs-redirects (>=1.2,<2.
 name = "mkdocs-material-extensions"
 version = "1.3.1"
 description = "Extension pack for Python Markdown and MkDocs Material."
-optional = true
+optional = false
 python-versions = ">=3.8"
 files = [
    {file = "mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31"},
@@ -2629,7 +2629,7 @@ files = [
 name = "paginate"
 version = "0.5.6"
 description = "Divides large result sets into pages for easier browsing"
-optional = true
+optional = false
 python-versions = "*"
 files = [
    {file = "paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d"},
@@ -3029,7 +3029,7 @@ testutils = ["gitpython (>3)"]
 name = "pymdown-extensions"
 version = "10.7"
 description = "Extension pack for Python Markdown."
-optional = true
+optional = false
 python-versions = ">=3.8"
 files = [
    {file = "pymdown_extensions-10.7-py3-none-any.whl", hash = "sha256:6ca215bc57bc12bf32b414887a68b810637d039124ed9b2e5bd3325cbb2c050c"},
@@ -3168,7 +3168,7 @@ six = ">=1.5"
 name = "pytz"
 version = "2024.1"
 description = "World timezone definitions, modern and historical"
-optional = true
+optional = false
 python-versions = "*"
 files = [
    {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"},
@@ -3251,7 +3251,7 @@ files = [
 name = "pyyaml-env-tag"
 version = "0.1"
 description = "A custom YAML tag for referencing environment variables in YAML files. "
-optional = true
+optional = false
 python-versions = ">=3.6"
 files = [
    {file = "pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069"},
@@ -3841,7 +3841,7 @@ optional = ["SQLAlchemy (>=1.4,<3)", "aiodns (>1.0)", "aiohttp (>=3.7.3,<4)", "b
 name = "smmap"
 version = "5.0.1"
 description = "A pure Python implementation of a sliding window memory map manager"
-optional = true
+optional = false
 python-versions = ">=3.7"
 files = [
    {file = "smmap-5.0.1-py3-none-any.whl", hash = "sha256:e6d8668fa5f93e706934a62d7b4db19c8d9eb8cf2adbb75ef1b675aa332b69da"},
@@ -4042,7 +4042,7 @@ tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
 name = "watchdog"
 version = "4.0.0"
 description = "Filesystem events monitoring"
-optional = true
+optional = false
 python-versions = ">=3.8"
 files = [
    {file = "watchdog-4.0.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:39cb34b1f1afbf23e9562501673e7146777efe95da24fab5707b88f7fb11649b"},
@@ -4315,10 +4315,7 @@ files = [
 docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"]
 testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy (>=0.9.1)", "pytest-ruff"]

-[extras]
-docs = ["mkdocs", "mkdocs-git-revision-date-localized-plugin", "mkdocs-material"]
-
 [metadata]
 lock-version = "2.0"
 python-versions = ">=3.9,<3.13"
-content-hash = "e7a91eb05e196ef02f7d753043e697ffe24e91f27f21ddebbec5d84640d92eb0"
+content-hash = "413c7498fb6495b69f8a06f45420b3763dff0894cea1ea8fa7ec718ad120fc1b"
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -46,9 +46,6 @@ detect-secrets = "1.4.0"
 google-api-python-client = "2.118.0"
 google-auth-httplib2 = ">=0.1,<0.3"
 jsonschema = "4.21.1"
-mkdocs = {version = "1.5.3", optional = true}
-mkdocs-git-revision-date-localized-plugin = {version = "1.2.4", optional = true}
-mkdocs-material = {version = "9.5.10", optional = true}
 msgraph-sdk = "^1.0.0"
 msrestazure = "^0.6.4"
 pydantic = "1.10.14"
@@ -58,9 +55,6 @@ shodan = "1.31.0"
 slack-sdk = "3.27.0"
 tabulate = "0.9.0"

-[tool.poetry.extras]
-docs = ["mkdocs", "mkdocs-material", "mkdocs-git-revision-date-localized-plugin"]
-
 [tool.poetry.group.dev.dependencies]
 bandit = "1.7.7"
 black = "24.2.0"
@@ -81,6 +75,11 @@ pytest-xdist = "3.5.0"
 safety = "3.0.1"
 vulture = "2.11"

+[tool.poetry.group.docs.dependencies]
+mkdocs = "1.5.3"
+mkdocs-git-revision-date-localized-plugin = "1.2.4"
+mkdocs-material = "9.5.10"
+
 [tool.poetry.scripts]
 prowler = "prowler.__main__:prowler"