changed docs and added publish pypi yml

Author: sinanerdinc

.github/workflows/ci.yml

@@ -64,10 +64,10 @@ jobs:
       - name: Generate HTML documentation
         run: |
           mkdir -p docs
-          python -m robot.libdoc MimesisLibrary docs/MimesisLibrary.html
+          python -m robot.libdoc MimesisLibrary docs/index.html
 
       - name: Upload documentation artifact
         uses: actions/upload-artifact@v4
         with:
           name: keyword-docs
-          path: docs/MimesisLibrary.html
+          path: docs/index.html

.github/workflows/publish.yml

@@ -0,0 +1,66 @@
+name: Upload Python Package to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: # Allows manual trigger from GitHub Actions tab
+
+permissions:
+  contents: read
+  id-token: write # Required for PyPI Trusted Publishing (OIDC)
+
+jobs:
+  test:
+    name: Test on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run unit tests
+        run: pytest tests/unit/ -v --tb=short
+
+      - name: Run Robot Framework acceptance tests
+        run: |
+          mkdir -p results
+          robot --outputdir results tests/acceptance/
+
+  publish:
+    name: Build & Publish to PyPI
+    needs: test
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/robotframework-mimesislibrary
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package distribution
+        run: python -m build
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

Makefile

@@ -33,8 +33,8 @@ typecheck: ## Type-check source code with mypy
 
 docs: ## Generate HTML keyword documentation with libdoc
 	mkdir -p docs
-	$(LIBDOC) MimesisLibrary docs/MimesisLibrary.html
-	@echo "Documentation generated at docs/MimesisLibrary.html"
+	$(LIBDOC) MimesisLibrary docs/index.html
+	@echo "Documentation generated at docs/index.html"
 
 clean: ## Remove build artifacts and caches
 	rm -rf dist/ build/ *.egg-info/ .pytest_cache/ .mypy_cache/ .ruff_cache/

README.md

@@ -103,7 +103,7 @@ Reproducible Test
 Generate the full keyword reference in HTML format:
 
 ```bash
-python -m robot.libdoc MimesisLibrary docs/MimesisLibrary.html
+python -m robot.libdoc MimesisLibrary docs/index.html
 ```
 
 ## Development Setup