doc2dash icon indicating copy to clipboard operation
doc2dash copied to clipboard

Support for pydoc

Open Finkregh opened this issue 1 year ago • 2 comments

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.

Finkregh avatar Jun 26 '23 10:06 Finkregh

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?

hynek avatar Jan 15 '24 05:01 hynek

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

Finkregh avatar Mar 06 '24 21:03 Finkregh