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

Support other docsets #28

Open
sonnyp opened this issue Nov 12, 2023 · 1 comment
Open

Support other docsets #28

sonnyp opened this issue Nov 12, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@sonnyp
Copy link
Contributor

sonnyp commented Nov 12, 2023

We currently support gi-docgen docs, we should support other formats.

@AkshayWarrier AkshayWarrier added the enhancement New feature or request label Nov 17, 2023
@AkshayWarrier
Copy link
Collaborator

I think the docsets of devdocs make the styling of all the docs uniform and strips the original styling which I don't particularly like.

And as for dashdocs, it does present the docs as it is but the format of the docset and the index it builds from it is not very useful.

For example this is what the index of numpy docs look like
image

And this what zealdocs creates
image

It simply dumps everything into these "broad categories" which is not useful to the user because it's impossible to browse, but also it's completely different from the organized sidebar of the native docs.

Imo, if want to provide all these docs offline then the experience of browsing through them should be at least as good as the online native counterparts. And for me personally, I wouldn't want to use an app that either removes all the styling from the docs or it doesn't let me browse the docs the same way as its online version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants