Unite scripts under samples
folder and the snippets in docs/source/examples.rst
#99
Labels
Milestone
samples
folder and the snippets in docs/source/examples.rst
#99
Currently, there are two things to concern about:
With every change to the user API, we need to update both - the sample applications, and the snippets in the documentation which are pretty similar. We need to find a way to embed those sample python scripts into the
.rst
files either by using the https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-download or by having a pre-step beforesphinx-build
is called which replace placeholders with each script content.In addition to the unit tests, we should have a script in the root directory that executes all the samples under the samples folder (to be executed from the
/c/gpu/build.sh
script and the pre-push hook). We can test the code in the documentation by using the doctest extension: https://www.sphinx-doc.org/en/master/usage/extensions/doctest.htmlThe text was updated successfully, but these errors were encountered: