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

Doxygen documentation not available #4114

Open
jwillemsen opened this issue Apr 12, 2023 · 5 comments
Open

Doxygen documentation not available #4114

jwillemsen opened this issue Apr 12, 2023 · 5 comments

Comments

@jwillemsen
Copy link
Member

The readme.md says Doxygen for the latest release is available at http://download.opendds.org/doxygen/., but that link gives a 404

@jrw972
Copy link
Contributor

jrw972 commented Apr 12, 2023

General Question about Doxygen: Do you find the oxygen useful and if so, would you rather download it as an artifact from GitHub or have it host somewhere like the DevGuide?

@jwillemsen
Copy link
Member Author

At least we should host it as artifact on github, when possible host it, but that is lower priority for me

@sonndinh
Copy link
Member

If I'm interested in Doxygen, I would prefer it hosted somewhere so I don't have to download it.

@iguessthislldo
Copy link
Member

iguessthislldo commented Apr 12, 2023

Personally I never found the doxygen to be of much use. I can't remember specific examples at the moment, but I know there's been instances where I was looking for information and it was missing. I tried to make it more useful by adding things like call graphs, but that mostly just inflated the size of the Doxygen.

That all being said I'm not against making the Doxygen available in a similar way to before if other people find it useful, but we'd have to come up with a new way to host and upload it if we're hosting it. I'd also like to reduce the size of it, it takes a while to generate it like it is now and it's almost a gigabyte in size. Besides building the shapes demo it's the part of the release process that takes the longest.

Even if we didn't do anything with the Doxygen in that form I have plans to make use of Doxygen in the sphinx documentation using Breathe for a public API reference. So I don't think the Doxygen config file is going away any time soon for people who wants to generate it themselves.

@iguessthislldo
Copy link
Member

As noted in #4639, when we do act on this in the release script we either need to update or rip out the support for downloading ACE/TAO.

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

Successfully merging a pull request may close this issue.

4 participants