Skip to content

Commit 46e4813

Browse files
grstbernheder
andauthored
Deploy using github actions (#7)
* action * initial * action * action * action * action * action * action * action * setup documentation action * setup documentation action * setup documentation action * update conf * more cleanup Co-authored-by: Bernhard Eder <[email protected]>
1 parent 3ecf8be commit 46e4813

File tree

8 files changed

+31
-560
lines changed

8 files changed

+31
-560
lines changed

.cruft.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
"project_name": "scverse-tutorials",
88
"package_name": "scverse_tutorials",
99
"project_description": "A very interesting piece of code",
10-
"author_full_name": "Your Name",
11-
"author_email": "[email protected]",
12-
"github_user": "your_github_username",
13-
"project_repo": "https://github.com/your_github_username/scverse-doc",
10+
"author_full_name": "scverse team",
11+
"author_email": "[email protected]",
12+
"github_user": "scverse",
13+
"project_repo": "https://github.com/scverse/scverse-tutorials",
1414
"license": "BSD 3-Clause License",
1515
"_copy_without_render": [
1616
".github/workflows/**.yaml",

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 89 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

.github/workflows/build.yaml

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Docs
2+
on: [push, pull_request, workflow_dispatch]
3+
jobs:
4+
docs:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v2
8+
- uses: actions/setup-python@v4
9+
with:
10+
python-version: "3.10"
11+
cache: "pip"
12+
cache-dependency-path: "pyproject.toml"
13+
- name: Install dependencies
14+
15+
run: python -m pip install .[doc]
16+
- name: Sphinx build
17+
run: |
18+
cd docs && make html
19+
- name: Deploy
20+
uses: peaceiris/actions-gh-pages@v3
21+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
22+
with:
23+
publish_branch: gh-pages
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: docs/_build/html
26+
force_orphan: true

.github/workflows/test.yaml

Lines changed: 0 additions & 62 deletions
This file was deleted.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
# -- Project information -----------------------------------------------------
1818

19-
info = metadata("scverse-doc")
19+
info = metadata("scverse-tutorials")
2020
project_name = info["Name"]
2121
author = info["Author"]
2222
copyright = f"{datetime.now():%Y}, {author}."

0 commit comments

Comments
 (0)