change sphinx output format to dirhtml

[saces]

this produces prettier urls without '.html' at the end

[marmarek]

It may be a bit late for that...

While URLs may be nicer, I think this would break links that are already out there, no? Especially the whole QubesOS/qubesos.github.io#243

Any rename/link change needs to come with matching redirect from the old one.

[maiska]

I wanted to test this out, @parulin also made the suggestion, I had some weird stuff locally I think with auto-build and did not have the time to look into this, and low prio, but coming I can and also prepare a redirects PR to qubesos.github.io.
It will take time, still low prio imho :)

[parulin]

I think it is too late now? All the current links with .html have to be redirected to the "clean links" and if it takes too much time, all the links containing anchors will be lost again.

[maiska]

I think it is too late now? All the current links with .html have to be redirected to the "clean links" and if it takes too much time, all the links containing anchors will be lost again.

no, i don't think so. there should not be anchors in the redirects, and if it is sufficiently tested and run by the link checker in rst itself we should be good. i do not see a lot of overhead here, but it will be approached at a slow pace and testing is needed

[parulin]

I think it is too late now? All the current links with .html have to be redirected to the "clean links" and if it takes too much time, all the links containing anchors will be lost again.

no, i don't think so. there should not be anchors in the redirects, and if it is sufficiently tested and run by the link checker in rst itself we should be good. i do not see a lot of overhead here, but it will be approached at a slow pace and testing is needed

Sorry, I wasn't clear. I had the forum in mind, or any external source: any link containing an anchor is lost.

I.e.: https://www.qubes-os.org/doc/glossary/#qube will redirect to https://doc.qubes-os.org/en/latest/user/reference/glossary.html, not https://doc.qubes-os.org/en/latest/user/reference/glossary.html#qube

So, moving again from https://doc.qubes-os.org/en/latest/user/reference/glossary.html to https://doc.qubes-os.org/en/latest/user/reference/glossary/ will have the same effect.

[maiska]

I think it is too late now? All the current links with .html have to be redirected to the "clean links" and if it takes too much time, all the links containing anchors will be lost again.

no, i don't think so. there should not be anchors in the redirects, and if it is sufficiently tested and run by the link checker in rst itself we should be good. i do not see a lot of overhead here, but it will be approached at a slow pace and testing is needed

Sorry, I wasn't clear. I had the forum in mind, or any external source: any link containing an anchor is lost.

I.e.: https://www.qubes-os.org/doc/glossary/#qube will redirect to https://doc.qubes-os.org/en/latest/user/reference/glossary.html, not https://doc.qubes-os.org/en/latest/user/reference/glossary.html#qube

So, moving again from https://doc.qubes-os.org/en/latest/user/reference/glossary.html to https://doc.qubes-os.org/en/latest/user/reference/glossary/ will have the same effect.

There is a possible solution to this: https://github.com/sphinx-doc/sphinxext-rediraffe

Let this be tackled in due time though. I would not like a discussion that needs time, and i cannot take the time to research and properly involve

[parulin]

So, moving again from https://doc.qubes-os.org/en/latest/user/reference/glossary.html to https://doc.qubes-os.org/en/latest/user/reference/glossary/ will have the same effect.

Never mind, I suppose that we will move from /latest/ to /stable/ URLs in the future so please ignore my previous comment :)

[marmarek]

Look what I found in RTD settings:

[rapenne-s]

Look what I found in RTD settings:

Did you enable it? Do we want to make a change about the .html at the end of URLs?

[marmarek]

Did you enable it?

No. Should I?

Note that redirects drop anchor part of the URL, so (old) links to specific sections won't work.

[parulin]

@maiska had some tests to run before that.

I still think that it would be better to change the builder and resolve QubesOS/qubes-issues#10251 at the same time, to limit the anchor problem.

[unman]

It will be a mistake to lose the ability to link within pages. It is widely used in the docs and for external reference. We should not do this.

[parulin]

It will be automatically managed by Sphinx for internal links. The only issue concerns external links to the docs. As I said, if resolving QubesOS/qubes-issues#10251 changes the default URLs, merging #1530 won't harm.

[unman]

I'm concerned mainly about external links - most people wont wade through a page to get to the meat they want. Being able to point them directly to a section is not something to be lost. #10251 does not impact this at all. I dont find `page.html` not to be pretty. Personally I prefer it. I'm minded to push back on this.