Merge pull request #38 from nanten2/#14-docs

Add documentation workflow

.github/workflows/gh-pages.yml

@@ -0,0 +1,31 @@
+name: Documentation
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  job:
+    name: Documentation
+    runs-on: ubuntu-latest
+    env:
+      PACKAGE_NAME: n_const
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install dependencies
+        run: |
+          pip3 install poetry
+          poetry install
+      - name: Build docs
+        run: |
+          poetry run sphinx-apidoc -efTM -t docs/_templates/apidoc -o docs/_source ${{ env.PACKAGE_NAME }}
+          poetry run sphinx-build -a docs docs/_build
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build

pyproject.toml

@@ -5,7 +5,7 @@ description = "Parse and declare NANTEN2/NASCO specific constants/parameters."
 license = "MIT"
 readme = "README.md"
 authors = ["KaoruNishikawa <k.nishikawa@a.phys.nagoya-u.ac.jp>"]
-homepage = "https://github.com/nanten2/N-CONST"
+homepage = "https://nanten2.github.io/N-CONST"
 repository = "https://github.com/nanten2/N-CONST"
 
 [tool.poetry.dependencies]