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

Documentation should be unified and fuzzy searchable #1

Open
asonolet opened this issue Jun 7, 2024 · 0 comments
Open

Documentation should be unified and fuzzy searchable #1

asonolet opened this issue Jun 7, 2024 · 0 comments

Comments

@asonolet
Copy link
Member

asonolet commented Jun 7, 2024

Today there is 3 to 4 documentations for MEDCoupling. This leads to some not being up to date, and the users being lost.

The mainly used documentation is the so called developer documentation, which regroups a broad documentation of MEDCoupling, and the API Doc. This doc is generated by doxygen. Doxygen is an amazing tool in its capacity to parse C++ code doc, but the html renderer is a bit outdated and the search function is not fuzzy matching. The other documentations are sphinx compiled with the classical theme ReadTheDocs - which is great and offers fuzzy matching search - , but their content is a bit outdated or duplicated relatively to the doxygen doc.

A proposed solution is to use breathe alongside sphinx to parse the xml output of doxygen in order to bring the best of sphinx and Doxygen together.

@asonolet asonolet added this to the Documentation effort milestone Jun 7, 2024
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

No branches or pull requests

1 participant