feat: robot doc https://shpaker.github.io/winregistry/winregistry.robot

.github/workflows/doc.yml

@@ -0,0 +1,23 @@
+---
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  doc:
+    runs-on: windows-latest
+    steps:
+      - uses: extractions/setup-just@v2
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.10
+      - uses: actions/checkout@v4
+      - run: |
+          python -m pip install poetry~=1.8.4
+          poetry install --no-ansi --sync
+      - run: just doc
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: robot_doc
+          path: index.html

.github/workflows/pypi.yml

@@ -1,4 +1,6 @@
 ---
+name: Build
+
 on:
   release:
     types: [created]

.github/workflows/tests.yml → .github/workflows/robot.yml

@@ -1,17 +1,16 @@
 ---
-name: Lint
+name: Robot
 
 on:
   pull_request:
     branches: [ main ]
 
 jobs:
-  lint:
+  tests:
     runs-on: windows-latest
     strategy:
       matrix:
         PYTHON_VERSION:
-#          - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
@@ -26,10 +25,10 @@ jobs:
       - uses: actions/checkout@v4
       - run: |
           python -m pip install poetry~=1.8.4
-          poetry install --no-ansi
+          poetry install --no-ansi --sync
       - run: just tests
       - uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: ${{ matrix.PYTHON_VERSION }}_robot_log
+          name: py${{ matrix.PYTHON_VERSION }}_robot_log
           path: log.html

Justfile

@@ -12,3 +12,6 @@ fix:
 
 tests:
     poetry run robot {{ TESTS_FILE }}
+
+doc:
+    poetry run libdoc winregistry.robot index.html

README.md

@@ -82,6 +82,12 @@ with open_key(
 
 ## Usage with [Robot Testing Framework](https://robotframework.org/)
 
+### Documentation
+
+https://shpaker.github.io/winregistry/winregistry.robot
+
+### Example
+
 ```robotframework
 *** Variables ***
 ${ SUITE_KEY_NAME }       HKLM\\SOFTWARE\\_ROBOT_TESTS_

winregistry.py

@@ -429,6 +429,11 @@ class robot:  # noqa: N801
     def registry_key_should_exist(
         key_name: str,
     ) -> None:
+        """
+        specified key should exist
+        Args:
+            key_name: sub_key is a string that identifies the sub_key to open
+        """
         with open_key(
             key_name,
             sub_key_ensure=False,