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

Adding dirhtml build mode support #85

Open
raddessi opened this issue Feb 27, 2022 · 0 comments
Open

Adding dirhtml build mode support #85

raddessi opened this issue Feb 27, 2022 · 0 comments
Labels
type:task An atomic feature / thing to be implemented

Comments

@raddessi
Copy link

raddessi commented Feb 27, 2022

Hi, thank you for all the work on this extension! It works beautifully.

I would like to add support for dirhtml build mode but want to confirm with you what approach you would like to use before sending up a PR.

Current experience

I like dirhtml builds because they provide cleaner URLs. I can specify -b dirhtml on the command line and that argument is passed along to sphinx correctly, but the pages and links generated by sphinx-multiversion still use the file-based urls.

Desired experience

I would like it if when -b dirhtml is passed on the CLI, the links and filesystem layout generated by sphinx-multiversion would match that of the sphinx-generated docs.

Proposed changes

I think that there are probably a few options.. an argument could be added to this project to mirror the upstream argument and then the value could be passed down, or we could just inspect the unparsed arguments and look for any -b <something> and match there. I think the first option is probably better but I will leave the design choices up to you. There also may be a better method :) Thoughts?

For reference only, this is an issue I noticed when working on pradyunsg/furo#372

@BurningEnlightenment BurningEnlightenment added the type:task An atomic feature / thing to be implemented label Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:task An atomic feature / thing to be implemented
Projects
Status: Backlog
Development

No branches or pull requests

2 participants