mirror of
https://github.com/obsproject/obs-studio.git
synced 2026-09-24 23:31:36 +08:00
CI: Update docs to Sphinx v3, fix warnings
Sphinx 3 adds a number of C and C++ friendly directives, making documenting our code much easier.
This commit is contained in:
committed by
Matt Gajownik
parent
60e94a2899
commit
ff555dd2b0
@@ -36,10 +36,15 @@ jobs:
|
||||
SCOPY="copyright = '([A-Za-z0-9, ]+)'"
|
||||
RCOPY="copyright = '2017-$(date +"%Y"), Hugh Bailey'"
|
||||
sed -i -E -e "s/${SVER}/${RVER}/g" -e "s/${SREL}/${RREL}/g" -e "s/${SCOPY}/${RCOPY}/g" docs/sphinx/conf.py
|
||||
- uses: ammaraskar/sphinx-action@master
|
||||
- uses: totaldebug/sphinx-publish-action@1.2.0
|
||||
with:
|
||||
docs-folder: "docs/sphinx/"
|
||||
sphinx_src: 'docs/sphinx'
|
||||
build_only: True
|
||||
target_branch: 'master'
|
||||
target_path: '../home/_build'
|
||||
- uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: OBS Studio Documentation (HTML)
|
||||
path: docs/sphinx/_build/html/
|
||||
path: |
|
||||
${{ runner.temp }}/_github_home/_build
|
||||
!${{ runner.temp }}/_github_home/_build/.doctrees
|
||||
|
||||
Reference in New Issue
Block a user