Skip to content

Commit

Permalink
Merge pull request #110 from kayjan/rtd-integration
Browse files Browse the repository at this point in the history
Rtd integration
  • Loading branch information
kayjan authored Oct 18, 2023
2 parents e37fac3 + 603f289 commit 868d46f
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 22 deletions.
16 changes: 3 additions & 13 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ on:
types:
- completed

permissions:
pull-requests: write

jobs:
setup:
runs-on: ubuntu-latest
Expand All @@ -36,16 +39,3 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true
- name: Deploy to RTD
uses: actions/upload-artifact@v2
with:
name: docs-${{ github.sha }}
path: docs/build/
- name: Trigger RTDs build
uses: dfm/rtds-action@v1
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
with:
webhook_url: ${{ secrets.RTD_URL }}
webhook_token: ${{ secrets.RTD_TOKEN }}
commit_ref: ${{ github.ref }}
1 change: 0 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@ autodocsumm==0.2.9
karma-sphinx-theme==0.0.8
myst-parser==0.18.1
pandas==1.5.1
rtds-action==1.1.0
sphinxemoji==0.2.0
8 changes: 0 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"myst_parser",
"sphinxemoji.sphinxemoji",
"sphinx.ext.mathjax",
"rtds_action",
]
autodoc_default_options = {"autosummary": True}
sphinxemoji_style = "twemoji"
Expand All @@ -38,13 +37,6 @@

language = "Python"

# GitHub Action Integration
rtds_action_github_repo = "kayjan/bigtree"
rtds_action_path = "../build/"
rtds_action_artifact_prefix = "docs-"
rtds_action_github_token = os.getenv("GH_TOKEN", "")
rtds_action_error_if_missing = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

Expand Down

0 comments on commit 868d46f

Please sign in to comment.