search

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.12k stars 145 forks source link

[Request] Tool for Dash docset generation #315

Closed xilopaint closed 7 months ago

xilopaint commented 3 years ago

Documentation sources built with Sphinx, PyDoctor and others have tools like doc2dash intended to generate Dash docsets. It would be nice to have something that could generate dash docsets out of pdoc docs.

I've tried to build a docset for Backtesting.py with no success.

See this: https://kapeli.com/docsets

kernc commented 3 years ago

Seems like compatibility with Sphinx and PyDoctor is a feature of doc2dash itself? Not sure what to do about it here. :grimacing:

Have you tried creating Dash docsets from any HTML documentation?

xilopaint commented 3 years ago

Seems like compatibility with Sphinx and PyDoctor is a feature of doc2dash itself?

Yes.

Have you tried creating Dash docsets from any HTML documentation?

I tried to do it using Dashing but it's hard and I gave up. doc2dash easily and efficiently creates docsets out of documentations built with Sphinx and do the mapping work between the elements of the docs and the Dash entry types. With Dashing you have to do it manually.