Reliable and up-to-date documentation is central to software project uptake and success. We have recently migrated project documentation to a Sphinx-based framework with Kokkos specialized tags to make clear the relationship between explanation and example with source code. We are systematically revising the API documentation, with a view to versioning this resource. Anyone can clone / fork the kokkos-core-wiki, and contribute. In this talk, I will overview issue and pull request creation, "nuts and bolts" requirements to build the Sphinx-based (detailed in the project README.md), and highlight resources that will inform users' contribution (e.g, Documentation Templates).
ajpowelsnl
commented
10 months ago
Reliable and up-to-date documentation is central to software project uptake and success. We have recently migrated project documentation to a Sphinx-based framework with Kokkos specialized tags to make clear the relationship between explanation and example with source code. We are systematically revising the API documentation, with a view to versioning this resource. Anyone can clone / fork the kokkos-core-wiki, and contribute. In this talk, I will overview issue and pull request creation, "nuts and bolts" requirements to build the Sphinx-based (detailed in the project README.md), and highlight resources that will inform users' contribution (e.g, Documentation Templates).