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

DOC: Old scripted effort to generate C-API documentation with Doxygen #19993

Closed
Mukulikaa opened this issue Sep 28, 2021 · 2 comments · Fixed by #20007
Closed

DOC: Old scripted effort to generate C-API documentation with Doxygen #19993

Mukulikaa opened this issue Sep 28, 2021 · 2 comments · Fixed by #20007

Comments

@Mukulikaa
Copy link
Contributor

Recently, I found a script in the cdoc directory that generates the C-API documentation with Doxygen. We can build the documentation with make build in that directory. I was wondering if it was there for a specific purpose.

That directory also has a Doxyfile with some configurations; @rossbar pointed out that it could be confusing to have 2 doxyfiles with configuration settings (the recent one was added when we integrated Doxygen and Breathe into the project).

I'm pinging @seiko2plus in case they have any opinions on this.

@charris
Copy link
Member

charris commented Sep 28, 2021

IIRC, there was an adaptation for documenting the C code with numpy docstrings using doxigen, I think @pv was the author.

@rossbar
Copy link
Contributor

rossbar commented Sep 29, 2021

We discussed this a bit in the community meeting and the consensus was that this should be removed in favor of the newer Doxygen/Breathe infrastructure that was recently added (see #18884 )

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

Successfully merging a pull request may close this issue.

3 participants