Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for pydoc #159

Open
Finkregh opened this issue Jun 26, 2023 · 2 comments
Open

Support for pydoc #159

Finkregh opened this issue Jun 26, 2023 · 2 comments

Comments

@Finkregh
Copy link

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
Copy link
Owner

hynek commented Jan 15, 2024

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
Copy link
Author

Finkregh commented Mar 6, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants