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

Incorporate Doxygen docs into the new website. #5

Open
brtnfld opened this issue Aug 15, 2024 · 1 comment
Open

Incorporate Doxygen docs into the new website. #5

brtnfld opened this issue Aug 15, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@brtnfld
Copy link
Member

brtnfld commented Aug 15, 2024

Using Doxygen+Breathe+Sphinx, generate the MLL and other API documentation and include it in the website.

@brtnfld
Copy link
Member Author

brtnfld commented Aug 15, 2024

@MicK7, I've completed the C MLL Doxygen into Read-the-docs. I created a docs directory in the CGNS repo and processed it in-place: https://github.com/brtnfld/CGNS/tree/breathe. If interested, you can build it by doing "make html" in the docs directory. You can view the results from _build/html/index/html

I'm wondering if we should add the CGNS source as a submodule in this repo and process it as part of an action or generate the webpage in the CGNS repository and reference it from this repo. What are your thoughts on the best way to do this?

It would be nice to version the documentation generated with a released version of CGNS.

Getting the C MLL into the website as proof of concept would be good before proceeding to the other documentation.

@brtnfld brtnfld added the enhancement New feature or request label Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant