I’ve got started here: GitHub - LostKobrakai/ex_doc_docset: ExDoc formater to build a docset for Dash/Zeal · GitHub
It should already work, but it’s not complete yet.
LostKobrakai
2
mayel
This thread inspired me to create a mix task which generates a single exdoc that includes docs for your app plus all of its dependencies (and nested deps) so you can simply browse and search them as if all your code and its dependencies were a monorepo: mix docs.deps (feel free to copy the code, improve, and share)
It includes the readme of each dep when one exists, but haven’t yet tried to include other guides. Also not sure how to include docs of Elixir itself.
1
LostKobrakai
Iirc this was brough up as well in the slack conversation preceeding this topic. I’ve looked a fair bit into it, but I’m not a big fan of how it needs to depend on the markup generated of ex_doc - a fact I’ll try to address in the future with my library. It’s also missing table of contents support and hiding layout. I didn’t try it, but I seem to recall it not working in it’s current state as well. Also there’s more to come from my side once I get around to implementing the ideas I have.
0
mayel
Yeah I didn’t mean to stop you! I used that repo in the past and it was quite broken (I submitted a big PR at the time, but not sure of its status since then)…
0
KristerV
KristerV
hello again. everyone who’s still building stuff - give us your updates!
my updates
i’m actually using my created app daily and find it quite convenient, even without really prioritizing the search results properly. here’s a few annoyances i’ve fixed:
- package list is now dynamic, so users can add what to index on the fly
- input is autofocused on launch (such innovation, i know)
- GitLab link added (omg not proud of this code at all but whatever)
- index page has small intro so users aren’t confused immediately.
1
tcoopman
I was really confused when I search for Enum that I don’t get all the functions of the Enum module. For example, map is not in there. But when I search for map it does show up?
Is that the intended behaviour?
0
KristerV
0
tcoopman
Hmm, probably had my eye on something else, but it does stop at map_join which is not the last function of Enum?
0