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

Autobuild launch from subdir #100

Closed Martiix closed 1 year ago

Martiix commented 3 years ago

Is your feature request related to a problem? Please describe.

My index file is not located directly in the source directory, but in a sub directory because the source is shared between several sphinx build. The location of the indexfile is therefore set in the config file using master_doc = path/to/index.rst. This causes sphinx to provide a link in the terminal that launch at 404: Not Found and the path to the index file has to be added to the url. Is there a way to change the url sphinx-autobuild connects to? http://0.0.0.0:port/path/to/index.html

Describe the solution you'd like

An additional argument in the sphinx-autobuild command, my imagination for variable names is bad, but something like: --launch /path/to/launch/from

Additional context I'm not using the make file, I'm building using this command: sphinx-autobuild -W -b html --host 0.0.0.0 --port 8000 -c path/to/conf sourcedir builddir

The livereload server accepts this argument, which might be helpful: :param default_filename: launch this file from the selected root on startup

made a suggestion pr: https://github.com/executablebooks/sphinx-autobuild/pull/101/commits/ffc015303cc617b16c28497cbb67af3814988fb4

welcome[bot] commented 3 years 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: