An overview of documentation complexity and an analysis of incentives. Background As mentioned a few times before, last year a proposal of mine to improve the documentation for the SymEngine organization was accepted under the Google Season of Docs 2020 initiative. This is a more personal and expanded discussion on the report submitted on the SymEngine Wiki regarding the goals and completion metrics. Figure 1: Promotional image Google seemed to strongly suggest
Unifying C++ and Python documentation. Background For almost half a decade my C++ projects have been either scoped to where plain Doxygen works well enough 1, or largely undocumented at the C++ API level 2. While integrating with Sphinx via exhale or breathe shown earlier 3 works well, it often fails to provide a smooth source code view or struggles with modern C++ constructs. For smaller, well formed libraries, the drawbacks of not being able to read the source are manifold, tending towards over-verbose documentation strings. Back in 2020 during the season of docs for Symengine, I stuck to pure doxygen with a custom theme, doxyYoda, a setup which served me well for Fortran projects like GaussJacobiQuad 4, and continues to be attractive.