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

Add a new --exec_script flag to run pre-build command #70

Closed
wants to merge 1 commit into from

Conversation

HarisGodil
Copy link

@HarisGodil HarisGodil commented Oct 3, 2018

Now sphinx-autobuild has the ability to run a script before building.

If the script errors out, sphinx-autobuild will print out a warning, but
otherwise continue.

My use case for this feature:
In my previous workflow of manually rebuilding, I had a script that
would automatically add in an automodule directive in the test
documentation. If someone changes what a test script references, I want
the automodule directives to also update.

For #69

@coveralls
Copy link

coveralls commented Oct 3, 2018

Coverage Status

Coverage decreased (-0.07%) to 76.0% when pulling dc599e0 on HarisGodil:exec_script into e0f40b6 on GaretJax:develop.

Now sphinx-autobuild has the ability to run a script before building.

If the script errors out, sphinx-autobuild will print out a warning, but
otherwise continue.

My use case for this feature:
In my previous workflow of manually rebuilding, I had a script that
would automatically add in an `automodule` directive in the test
documentation. If someone changes what a test script references, I want
the `automodule` directives to also update.
@pradyunsg
Copy link
Collaborator

Oooo! Interesting! I'll take a bit of time to come around to reviewing this -- just got the commit bit recently #81 -- but this looks like a really good thing to add. :)

@pradyunsg pradyunsg changed the title adds --exec_script flag to run pre-build command Add a new --exec_script flag to run pre-build command Aug 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants