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

Alternative for pydoctor to produce the python API documentation #2237

Open
brockho opened this issue Nov 10, 2023 · 2 comments
Open

Alternative for pydoctor to produce the python API documentation #2237

brockho opened this issue Nov 10, 2023 · 2 comments
Labels

Comments

@brockho
Copy link
Contributor

brockho commented Nov 10, 2023

Our documentation of the python modules (such as https://numbbo.github.io/coco-doc/apidocs/cocoex/) are done with the pydoctor tool that is outdated for some years now and very difficult to use (I think, only @nikohansen knows how to use it). What would be the best way to produce the documentation, if possible, in an automated way?

@tristanlatr
Copy link

Pydoctor is maintained upstream, it’s just that you guys use a very old version…

https://github.com/twisted/pydoctor

@olafmersmann
Copy link
Contributor

We should add a task to build the API documentation in CI.

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

No branches or pull requests

3 participants