liran-funaro / sphinx-markdown-builder

A Sphinx extension to add markdown generation support.
https://pypi.org/project/sphinx-markdown-builder
MIT License
32 stars 14 forks source link

[BUG] Builder is not registered when using `-b` option to sphinx-build #13

Closed zanchey closed 4 months ago

zanchey commented 6 months ago

In sphinx-markdown-builder 0.5.5, the builder can be activated manually using the -b option to sphinx-build, without adding it to the extensions list in the configuration.

In 0.6.0-0.6.5, this fails with

Sphinx error:
Builder name markdown not registered or available through entry point

To reproduce, using pipx for simplicity, but same occurs in a virtualenv:

pipx install sphinx
pipx inject sphinx sphinx-markdown-builder==0.5.5
sphinx-build -b markdown sourcedir outdir # works
pipx inject sphinx sphinx-markdown-builder==0.6.5 # or 0.6.0
sphinx-build -b markdown sourcedir outdir # error above is produced

Occurs on Debian Linux 11 and macOS 14, under both pipx and virtualenv.

I think the fix here is to update pyproject.toml - see https://www.sphinx-doc.org/en/master/development/builders.html

liran-funaro commented 5 months ago

Thank you for the report. I'm sorry it took some time to reply. I attended to this issue in version 0.6.6. Please check it out and update here if this works for you.

zanchey commented 4 months ago

Yes, that's great! Thanks.