Add simple documentation (#9)

.github/workflows/documentation.yml

@@ -0,0 +1,37 @@
+name: Documentation
+
+on:
+ push:
+ branches:
+ - main
+
+jobs:
+ documentation:
+ runs-on: ubuntu-latest
+ steps:
+ - name: checkout source
+ uses: actions/checkout@v3
+
+ - name: Set up python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
+ cache: "pip"
+ cache-dependency-path: "pyproject.toml"
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ python -m pip install -e .[docs]
+
+ - name: Create documentation
+ run: pdoc --html src/sleplet
+
+ - name: Deploy
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./html/sleplet
+ publish_branch: gh-pages
+ user_name: "github-actions[bot]"
+ user_email: "github-actions[bot]@users.noreply.github.com"

README.md

@@ -2,6 +2,7 @@
 
 Template for python development
 
+[![Documentation](https://github.com/astro-informatics/sleplet/actions/workflows/documentation.yml/badge.svg)](https://astro-informatics.github.io/sleplet)
 [![tests](https://github.com/paddyroddy/python-template/actions/workflows/tests.yml/badge.svg)](https://github.com/paddyroddy/python-template/actions/workflows/tests.yml)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 

pyproject.toml

@@ -30,6 +30,9 @@ optional-dependencies.dev = [
  "pre-commit",
  "tox",
 ]
+optional-dependencies.docs = [
+ "pdoc3",
+]
 urls.homepage = "https://github.com/paddyroddy/python-template"
 
 [tool.coverage]

src/example/__init__.py

@@ -0,0 +1,3 @@
+"""
+.. include:: ../../README.md
+"""