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

Unite scripts under samples folder and the snippets in docs/source/examples.rst #99

Closed
ohadmo opened this issue Aug 7, 2020 · 1 comment · Fixed by #111
Closed

Unite scripts under samples folder and the snippets in docs/source/examples.rst #99

ohadmo opened this issue Aug 7, 2020 · 1 comment · Fixed by #111
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@ohadmo
Copy link
Member

ohadmo commented Aug 7, 2020

Currently, there are two things to concern about:

  1. 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 before sphinx-build is called which replace placeholders with each script content.

  2. 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.html

@ohadmo ohadmo added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 7, 2020
@ohadmo ohadmo added this to the v0.1.0-rc2 milestone Aug 7, 2020
@ohadmo ohadmo self-assigned this Aug 24, 2020
ohadmo added a commit to ohadmo/VariantWorks that referenced this issue Aug 24, 2020
ohadmo added a commit to ohadmo/VariantWorks that referenced this issue Aug 25, 2020
ohadmo added a commit to ohadmo/VariantWorks that referenced this issue Aug 25, 2020
- Add docs folder to pydocstyle check (exclude sphinx configuration file)

Fixes NVIDIA#99
@ohadmo
Copy link
Member Author

ohadmo commented Aug 25, 2020

The 1st section is addressed in PR #111, we decided to keep a different implementation for the documentation snippets and samples.

Regarding the 2nd section, in PR #111 we test the documentation snippets. The sample scripts will be added to the CI in Issue #110 & #107

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant