Hacker News new | ask | show | jobs
by zdw 885 days ago
Could you rate the documentation generators based on how easy they are to consume?

I'd like to know how Sphinx, Docsy, MkDocs, Docbook, etc. compare in terms of being easy to semantically extract.

1 comments

I'd need to look up the individual scrapers for a fair comparison, since I tend to forget/mixup the challenges. Some scrapers have been around for 10 years and only required little updates.

In general the more native HTML elements and the more descriptive CSS classes are used the easier it gets. Disadvantageous is when great parts of a doc page are built using JavaScript, e.g. when the whole nav is generated dynamically as the nav is typically the source for categorization/grouping on devdocs.