Merge pull request #2 from robert-lieck/dev

merge dev branch

Author: robert-lieck

Diff for: .github/workflows/docs.yml

@@ -5,7 +5,6 @@ on:
     branches:
       - main
     tags: '*'
-  pull_request:
   workflow_dispatch:
 
 permissions:

Diff for: .github/workflows/docs_dev.yml

@@ -0,0 +1,26 @@
+name: doc_dev
+
+on:
+  push:
+    branches:
+      - dev
+    tags: '*'
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: generate doc
+        run: |
+          pip install -r requirements.txt
+          pip install -r doc/requirements.txt
+          cd doc/
+          make html
+          make linkcheck

Diff for: .github/workflows/tests.yml

@@ -3,8 +3,6 @@ name: tests
 on:
   push:
     branches: [ main ]
-  pull_request:
-    branches: [ main ]
   workflow_dispatch:
 
 jobs:
@@ -39,7 +37,7 @@ jobs:
       run: |
         pytest --cov=pythontemplatepackage --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v3
       with:
         env_vars: OS,PYTHON
         fail_ci_if_error: true

Diff for: .gitignore

@@ -70,6 +70,8 @@ instance/
 
 # Sphinx documentation
 doc/_build/
+doc/_autosummary
+doc/auto_examples
 
 # PyBuilder
 target/

Diff for: doc/conf.py

@@ -61,6 +61,8 @@
 imgmath_image_format='svg'
 # intersphinx mappings
 intersphinx_mapping = {}
+# report broken links
+nitpicky = True
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

Diff for: doc/index.rst

@@ -7,15 +7,18 @@ Welcome to PythonTemplatePackage's documentation!
    :maxdepth: 4
    :caption: Contents:
 
+   auto_examples/index.rst
    api_summary
 
 .. ...add more elements to table of contents
 
-Code examples are automatically tested
+You can include code as part of the documentation, which is automatically tested
 
    >>> print("Hello World")
    Hello World
 
+You can also include examples, which are shown in the :doc:`auto_examples/index`.
+
 
 .. autoclass:: pythontemplatepackage.myclass.MyClass
    :members:

Diff for: doc/requirements.txt

@@ -3,4 +3,5 @@ sphinx-rtd-theme
 myst-parser
 sphinx-autodoc-typehints
 autoclasstoc
-sphinx-gallery
+sphinx-gallery
+matplotlib

Diff for: examples/plot_example.py

@@ -0,0 +1,14 @@
+"""
+Example
+===========================
+
+An example Python file.
+"""
+
+# %%
+# Some Python Code
+# ------------------------
+#
+# Example code will be executed and shown in the documentation:
+
+print("Hello World")

Diff for: setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name="pythontemplatepackage",
-    version="0.0.3",
+    version="0.0.4",
     author="Robert Lieck",
     author_email="[email protected]",
     description="A template repo for Python packages with GitHub actions and documentation",