Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support SPHINXOPTS #15

Merged
merged 4 commits into from
Oct 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Input Default Required Description
``$repository_path`` to pip
requirements file
``sphinx_version`` ``''`` ``false`` Custom version of Sphinx
``sphinx_options`` ``''`` ``false`` Additional Sphinx options
======================= ============== ============ =============================

Examples
Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ inputs:
description: 'Version of Sphinx'
required: false
default: ''
sphinx_options:
description: 'Additional Sphinx options'
required: false
default: ''

runs:
using: 'node12'
Expand Down
2 changes: 1 addition & 1 deletion main.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ echo Temp directory \"$tmp_dir\" is created
echo ::endgroup::

echo ::group:: Running Sphinx builder
if ! sphinx-build -b html "$doc_dir" "$tmp_dir"; then
if ! sphinx-build -b html "$doc_dir" "$tmp_dir" $INPUT_SPHINX_OPTIONS; then
echo ::endgroup::
echo ::group:: Dumping Sphinx error log
for l in $(ls /tmp/sphinx-err*); do
Expand Down