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

Support SPHINXOPTS #15

merged 4 commits into from
Oct 12, 2022

Conversation

haiiliin
Copy link

@haiiliin haiiliin commented Oct 12, 2022

This pull request attempts to add support for the SPHINXOPTS.

Closes #14.

@haiiliin haiiliin changed the title Support SPHINXOPTS environment variable Support SPHINXOPTS Oct 12, 2022
@haiiliin
Copy link
Author

haiiliin commented Oct 12, 2022

I use an all-caps input variable SPHINXOPTS to keep consistent with the Sphinx environment variable SPHINXOPTS, if you prefer something like sphinx_opts, I can change it to sphinx_opts.

action.yml Outdated
@@ -30,6 +30,10 @@ inputs:
description: 'Version of Sphinx'
required: false
default: ''
SPHINXOPTS:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use snake_case for this new input parameter. Besides, I favor sphinx_options instead of sphinx_opt.

We can declare the input parameter in lower case, but use upper case in main.sh, GitHub does this conversion for us.

Copy link
Author

@haiiliin haiiliin Oct 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I have changed it to sphinx_options

Copy link
Member

@SilverRainZ SilverRainZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@SilverRainZ SilverRainZ merged commit 5452140 into sphinx-notes:v2 Oct 12, 2022
SilverRainZ added a commit that referenced this pull request Mar 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Add support for additional Sphinx options
2 participants