search

sphinx-doc / sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.
MIT License
523 stars 75 forks source link

Provide a way to pass arbitary arguments to sphinx-build #128

Closed Cadair closed 2 months ago

Cadair commented 1 year ago

Context

Quite often when working on the sunpy documentation I want to pass -D plot_gallery=0 to sphinx to skip the execution of our sphinx-gallery examples. As far as I can see there is no way to do this with sphinx-autobuild at the moment?

Proposal

No response

Tasks and updates

No response

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

chrysle commented 1 year ago

Have a look at sphinx-autobuild's help:

...
sphinx's arguments:
  The following arguments are forwarded as-is to Sphinx. Please look at `sphinx --help` for more information.
    -b=builder, -a, -E, -d=path, -j=N, -c=path, -C, -D=setting=value, -t=tag, -A=name=value, -n, -v, -q, -Q, -w=file, -W, -T, -N, -P