Skip to content

Commit

Permalink
Update doc build
Browse files Browse the repository at this point in the history
* try githubs action adapted from sphinx documention
* add requirements.txt for sphinx build action
* fix extlinks needing another %s
* fix mangled pr link in 2.3 release notes
  • Loading branch information
darcymason committed Apr 26, 2023
1 parent 0f8870d commit 3d6f78a
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 3 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/push-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Docs build

on: push

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "doc/"
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: html-docs
path: doc/_build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# If pushing into main branch, also deploy to github pages
if: github.ref == 'refs/heads/master'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/_build/html
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@
'https://github.com/pydicom/%s',
None
),
"issue": ("https://github.com/pydicom/pydicom/issues/%s", "#"),
"pr": ("https://github.com/pydicom/pydicom/pull/%s", "#"),
"issue": ("https://github.com/pydicom/pydicom/issues/%s", "#%s"),
"pr": ("https://github.com/pydicom/pydicom/pull/%s", "#%s"),
}

# intersphinx configuration
Expand Down
2 changes: 1 addition & 1 deletion doc/release_notes/v2.3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Enhancements
the slowest handler (:issue:`1487`)
* Added, enhanced, or removed a number of Mitra private dictionary entries (:pr:`1588`)
* Added support for unpacking bit-packed data without using NumPy to
:func:`~pydicom.pixel_data_handlers.utils.unpack_bits`(:pr:`1594`)
:func:`~pydicom.pixel_data_handlers.utils.unpack_bits` (:pr:`1594`)
* Added :func:`~pydicom.pixel_data_handlers.util.expand_ybr422` for expanding
uncompressed ``YBR_FULL_422`` data to ``YBR_FULL`` (:pr:`1593`)
* Replacement of ``UN`` VR with ``SQ`` VR for undefined length data elements
Expand Down
9 changes: 9 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
numpy
numpydoc
matplotlib
pillow
sphinx
sphinx_rtd_theme
sphinx-gallery
sphinxcontrib-napoleon
sphinx-copybutton

0 comments on commit 3d6f78a

Please sign in to comment.