Skip to content

Commit

Permalink
update for doc
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierr committed Jan 15, 2024
1 parent 8980146 commit 41594a1
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 52 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "Sphinx: Render docs"

on:
push:
branches: [ sphinx ]

jobs:
build:

runs-on: ubuntu-latest

permissions:
contents: write

steps:
- uses: actions/checkout@v4
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "sphinx/"
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: documentationHTML
path: sphinx/_build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/dev'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: sphinx/_build/html

43 changes: 0 additions & 43 deletions .github/workflows/update_ghpages.yml

This file was deleted.

10 changes: 1 addition & 9 deletions sphinx/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#+begin_src
pip install sphinx
#+end_src
** install sphinx rtd theme
** install sphinx pydata theme
https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html
#+begin_src
pip install pydata-sphinx-theme
Expand All @@ -14,14 +14,6 @@
#+begin_src
pip install sphinxcontrib-globalsubs
#+end_src
** youtube
#+begin_src shell
pip install sphinxcontrib-youtube
#+end_src
** collapse
#+begin_src shell
python -m pip install sphinx_collapse
#+end_src
** autosectionlabel
- part of default distribution
- We use ~autosectionlabel_prefix_document = True~ which means that the internal link must be prefixed by the file
Expand Down

0 comments on commit 41594a1

Please sign in to comment.