Conversation
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a comprehensive overhaul and modernization of the documentation system for the project. It establishes a robust, reproducible, and CI-validated Sphinx/Doxygen/Breathe documentation build, both locally and on Read the Docs, and provides clear guides and structure for users and contributors. The changes include new configuration files, improved build instructions, integration with CI, and a complete reorganization of the documentation content for the Python, C, and MATLAB/Octave APIs.
Documentation build system and CI integration:
.github/workflows/docs.yml) to build the documentation on every PR and push, matching the Read the Docs build environment and catching documentation issues before merging..readthedocs.yamlconfiguration that fully defines the RTD build process, including explicit dependency installation and Sphinx build commands with strict error checking.Doxyfilefor Doxygen, generating XML output for Breathe/Sphinx integration, with careful configuration to avoid issues with undocumented members, macro expansion, and cross-file references.Local documentation build improvements:
docs/README.mdwith clear, step-by-step instructions for building the documentation locally, emphasizing that no C++ compiler is needed and providing troubleshooting tips for Sphinx/Doxygen builds.CMakeLists.txtto add a conveniencedocstarget for users who prefer building documentation via CMake, though it is not required for the main documentation workflow.Sphinx configuration and documentation content reorganization:
docs/conf.pywith robust configuration for Sphinx, Breathe, MyST, and autodoc, including automatic Doxygen invocation, mocked imports for the compiled extension, and improved cross-referencing and warning suppression.docs/python-api/index.md), C API (docs/c-api/index.mdand subpages), and MATLAB/Octave interface (docs/matlab-api/index.md), each with structured quickstarts, API references, and usage notes. [1] [2] [3] [4] [5] [6]docs/index.md) to provide a clear, navigable entry point with links to all major API sections and the source repository.docs/getting-started/installation.mdby including the canonical build guide and clarifying the relationship between documentation and code builds.