Skip to content

Commit 868d46f

Browse files
authored
Merge pull request #110 from kayjan/rtd-integration
Rtd integration
2 parents e37fac3 + 603f289 commit 868d46f

File tree

3 files changed

+3
-22
lines changed

3 files changed

+3
-22
lines changed

.github/workflows/docs.yml

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ on:
1010
types:
1111
- completed
1212

13+
permissions:
14+
pull-requests: write
15+
1316
jobs:
1417
setup:
1518
runs-on: ubuntu-latest
@@ -36,16 +39,3 @@ jobs:
3639
github_token: ${{ secrets.GITHUB_TOKEN }}
3740
publish_dir: docs/build/
3841
force_orphan: true
39-
- name: Deploy to RTD
40-
uses: actions/upload-artifact@v2
41-
with:
42-
name: docs-${{ github.sha }}
43-
path: docs/build/
44-
- name: Trigger RTDs build
45-
uses: dfm/rtds-action@v1
46-
env:
47-
GH_TOKEN: ${{ secrets.GH_TOKEN }}
48-
with:
49-
webhook_url: ${{ secrets.RTD_URL }}
50-
webhook_token: ${{ secrets.RTD_TOKEN }}
51-
commit_ref: ${{ github.ref }}

docs/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ autodocsumm==0.2.9
22
karma-sphinx-theme==0.0.8
33
myst-parser==0.18.1
44
pandas==1.5.1
5-
rtds-action==1.1.0
65
sphinxemoji==0.2.0

docs/source/conf.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
"myst_parser",
2929
"sphinxemoji.sphinxemoji",
3030
"sphinx.ext.mathjax",
31-
"rtds_action",
3231
]
3332
autodoc_default_options = {"autosummary": True}
3433
sphinxemoji_style = "twemoji"
@@ -38,13 +37,6 @@
3837

3938
language = "Python"
4039

41-
# GitHub Action Integration
42-
rtds_action_github_repo = "kayjan/bigtree"
43-
rtds_action_path = "../build/"
44-
rtds_action_artifact_prefix = "docs-"
45-
rtds_action_github_token = os.getenv("GH_TOKEN", "")
46-
rtds_action_error_if_missing = True
47-
4840
# -- Options for HTML output -------------------------------------------------
4941
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
5042

0 commit comments

Comments
 (0)