Add release.yml for publishing to pypi (#164)

Author: speedyleion

.github/workflows/pythonpackage.yml

@@ -1,6 +1,7 @@
+---
 name: Python package
 
-on: [push]
+"on": [push]
 
 jobs:
   test:
@@ -9,28 +10,28 @@ jobs:
       matrix:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - id: tox-env
-      run: |
-        VERSION=${{ matrix.python-version }}
-        echo "environment=${VERSION//.}" >> $GITHUB_OUTPUT
-    - name: Install LLVM and Clang
-      uses: KyleMayes/install-llvm-action@v1
-      with:
-        version: "16.0"
-    - name: Symlink libclang.so
-      run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-16.so
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox 
-    - name: Test with tox
-      run: |
-        tox -e py${{ steps.tox-env.outputs.environment }}
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - id: tox-env
+        run: |
+          VERSION=${{ matrix.python-version }}
+          echo "environment=${VERSION//.}" >> $GITHUB_OUTPUT
+      - name: Install LLVM and Clang
+        uses: KyleMayes/install-llvm-action@v1
+        with:
+          version: "16.0"
+      - name: Symlink libclang.so
+        run: sudo ln -s ${{ env.LLVM_PATH }}/lib/libclang.so /usr/lib/x86_64-linux-gnu/libclang-16.so
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Test with tox
+        run: |
+          tox -e py${{ steps.tox-env.outputs.environment }}
 
   coverage:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+---
+name: Publish Python 🐍 distributions 📦 to PyPI
+
+"on":
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI 
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/project/sphinx-c-autodoc
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Build a wheel and a source tarball
+        run: python -m build
+      - name: Check with twine
+        run: twine check dist/*
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/[email protected]

.readthedocs.yml

@@ -1,3 +1,4 @@
+---
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
@@ -11,17 +12,14 @@ sphinx:
   # changelog so do not fail on warning
   fail_on_warning: false
 
-# Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
-
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optionally set the version of Python and requirements required to build your
+# docs
 python:
   version: 3.7
   install:
     - method: pip
       path: .
-    - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt

README.rst

@@ -36,13 +36,17 @@ Could be referenced in documentation as:
 
 With the resulting documentation output of:
 
-.. c:function:: int my_adding_function(int a, int b)
+.. Note this isn't using the c:function directive because that doesn't work on
+   pypi
 
+int my_adding_function(int a, int b) 
     A simple function that adds.
 
-    :param a: The initial value
-    :param b: The value to add to `a`
-    :returns: The sum of `a` and `b`
+    :Parameters:
+        * **a** - The initial value
+        * **b** - The value to add to `a`
+
+    :Returns: The sum of `a` and `b`
 
 .. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
 .. _Sphinx: https://www.sphinx-doc.org/en/master/index.html