fosstodon.org is one of the many independent Mastodon servers you can use to participate in the fediverse.
Fosstodon is an invite only Mastodon instance that is open to those who are interested in technology; particularly free & open source software. If you wish to join, contact us for an invite.

Administered by:

Server stats:

9.8K
active users

#pdoc

0 posts0 participants0 posts today

OK, #python question: How do I generate docs for an embedded python project that uses a #SWIG generated library? #pydoc #pdoc and the like rightly complain about non-existent modules, but all the information I want is contained in docstrings and type annotations, so it *should* be possible to generate docs right?

Is there a tool for this?

If you are looking for a nice way to document your Python project, you should really have a look at pdoc maintained by the incredible @max - it works, it's convenient and very practical.

Don't be confused by pdoc3 which is a crappy fork and should be discarded.

GitHubGitHub - mitmproxy/pdoc: API Documentation for Python ProjectsAPI Documentation for Python Projects. Contribute to mitmproxy/pdoc development by creating an account on GitHub.