Rename to sphinx-helm (#1)

.gitattributes

@@ -1 +1 @@
-frigate/_version.py export-subst
+sphinx-helm/_version.py export-subst

.github/workflows/test.yaml

@@ -0,0 +1,29 @@
+name: "Test sphinx-helm"
+on:
+  pull_request:
+  push:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: pip install -e .
+      - name: Run tests
+        run: pytest
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4

.pre-commit-config.yaml

@@ -6,6 +6,6 @@ repos:
     hooks:
       - id: flake8
         args: ["--exclude=src,style,test"]
-        files: frigate/.*$
+        files: sphinx-helm/.*$
 default_language_version:
   python: python3

MANIFEST.in

@@ -1,4 +1,4 @@
 include versioneer.py
-include frigate/_version.py
-include frigate/templates/*.jinja2
-exclude frigate/tests
+include sphinx-helm/_version.py
+include sphinx-helm/templates/*.jinja2
+exclude sphinx-helm/tests

README.md

@@ -1,67 +1,32 @@
-# Frigate
+# sphinx-helm
 
-Frigate is a tool for automatically generating documentation for your [Helm charts](https://helm.sh/).
+sphinx-helm is a Sphinx plugin for automatically generating documentation for your [Helm charts](https://helm.sh/).
 
 <!-- TODO: Add badges for CI, PyPI, etc -->
 
 Features:
 
 - Render documentation from your `Chart.yaml` and `values.yaml` files.
-- Supports outputting as markdown, reStructuredText and HTML.
 - Sphinx extension for including in Python documentation.
 
 ## Installation
 
 ```
-$ pip install frigate
+$ pip install sphinx-helm
 ```
 
 ## Usage
 
-```
-$ frigate gen path/to/chart
-
-Chart
-==========
+Add the extension to your Sphinx config.
 
-Chart description.
+```python
+# conf.py
 
-...
+extensions = ['sphinx-helm']
 ```
 
-<!-- TODO: Link to docs once set up on RTD -->
-
-
+Use the directive to generate documentation for your helm chart.
 
-### Pre-commit-hook
-
-Into the repository you want to have the pre-commit hook installed, run:
-
-
-```
-cat <<EOF >> .pre-commit-config.yaml
-- repo: https://github.com/rapidsai/frigate
-  rev: v0.4.0 #  pre-commit autoupdate  - to keep the version up to date
-  hooks:
-    - id: frigate
-EOF
+```rst
+.. helm:: path/to/your/helm/chart
 ```
-
-
-#### Parameters
-
-You can add extra parameters with :
-
-
-```
-- repo: https://github.com/rapidsai/frigate
-  rev: v0.4.0 #  pre-commit autoupdate  - to keep the version up to date
-  hooks:
-    - id: frigate
-      args:
-        - --output=README.rst
-        - --format=rst
-        - --no-credits
-        - --no-deps
-
-```