allow non-alphabetical sorting in the sidebar about pdoc

[mhils]

The sidebar sorts exactly like the page contents, that is in order of declaration in the Python file. For example, on https://pdoc.dev/docs/pdoc/doc.html, you can see that Module comes before Class. What are you looking for?

[fnrizzi]

Thank you for the reply.
I was referring to the submodules
These are alphabetical

[mhils]

How would you want them to be ordered?

[fnrizzi]

I would like to choose how to order them. for my case, alphabetical order does not make sense. There is a clear logical order , from basic to more advanced modules, so I would like to reflect that.

I did try to customize the order by using the customization suggested and modifying the "submodules" jinja2 block but that did not work fully. Some submodules ended up with broken links.

So I was just going to ask if there is a way or, if not, suggest to add such an option. I think in general it would be useful.

[mhils]

There is no way to customize the order at the moment, and I don't think that feature meets the bar of general applicability/usefulness unfortunately. Sorry!

[fnrizzi]

I don't think that feature meets the bar of general applicability/usefulness unfortunately

I don't quite agree with this. How is this feature not useful in general?
Pretty much every scientific library for example has an inherent "logical" order for exploring/understanding things.
So NOT having this functionality poses an immediate block to the usability of the documentation.
Since a documenation's first purpose is to explain things, i believe this is critical.

[fnrizzi]

if you don't want to support it, can you please at least point me to where in the pdoc source I can find the code that sorts the submodules in the sidebar?

[mhils]

Sure! The implementation is at https://github.com/mitmproxy/pdoc/blob/v14.1.0/pdoc/doc.py#L455. From a brief glance it looks like you may actually be able to add custom sorting by specifing __all__, so maybe that's a feature we actually have. :)

[fnrizzi]

it worked! Pressio/rom-tools-and-workflows#30 thank you