Merge pull request #2 from Mab879/fix_docs

Fix Docs

.editorconfig

@@ -4,7 +4,7 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-[**.py]
+[{**.py,**.yml,**.yaml}]
 indent_style = space
 indent_size = 4
 

.github/workflows/docs.yaml

@@ -0,0 +1,27 @@
+name: Docs
+on:
+    push:
+        branches: [ 'main', '*' ]
+    pull_request:
+        branches: [ 'main', ]
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.number || github.run_id }}
+    cancel-in-progress: true
+jobs:
+    validate-docs:
+        name: Validate Docs
+        runs-on: ubuntu-latest
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+            -   name: Install Dependencies
+                run: pip install -r docs/requirements.txt build
+            -   name: Build the project
+                run: python -m build
+            -   name: Install the project
+                run: pip install dist/compliance_tool-*-py3-none-any.whl
+            -   name: Build the Docs
+                working-directory: docs
+                run: make html
+            -   name: Ensure the docs built
+                run: grep 'Sub-commands' docs/_build/html/compliance-tool.1.html

compliance_tool/cli.py

@@ -1,7 +1,5 @@
 import argparse
-import list
-import scan
-import remediate
+from compliance_tool import list, scan, remediate
 
 
 def prepare_parser_list(subparsers) -> None:

docs/compliance-tool.1.rst

@@ -2,9 +2,10 @@
 
 compliance-tool
 ===============
+.. currentmodule:: compliance_tool
 
 .. argparse::
    :module: compliance_tool.cli
-   :func: prepare_parser
+   :func: prepare_parsers
    :prog: compliance-tool