search

hynek / doc2dash

Create docsets for Dash.app-compatible API browsers.
https://doc2dash.hynek.me/
MIT License
562 stars 38 forks source link

Support for pydoc #159

Open Finkregh opened 1 year ago

Finkregh commented 1 year ago

Thanks for your work!

It would be great if I could just point the script at a python package, and it would generate the docs from the output of pydoc.

Perhaps https://pypi.org/project/pydoc-markdown/ could help, I did not read up on which format Dash requires though.

hynek commented 8 months ago

I'm afraid the problem here is that there is no such thing as "output from pydoc" – at least not on a general built-docs basis. doc2dash is emphatically not in the building-documentation business.

What exactly does pydoc-markdown put out? Could it be taught intersphinx?

Finkregh commented 6 months ago

Something along the lines of https://pythonhosted.org/an_example_pypi_project/sphinx.html?