-
Notifications
You must be signed in to change notification settings - Fork 68
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
Documentation Refactor #1153
Documentation Refactor #1153
Conversation
…gallery, add selection tutorial
@ttung if you want to commit directly against this branch, or PR against it to fix the CI, that would be a good next step. 👍 |
Codecov Report
@@ Coverage Diff @@
## ajc-sphinx-gallery #1153 +/- ##
=======================================================
+ Coverage 59.94% 89.89% +29.94%
=======================================================
Files 172 120 -52
Lines 6664 4414 -2250
=======================================================
- Hits 3995 3968 -27
+ Misses 2669 446 -2223
Continue to review full report at Codecov.
|
New targets: run-examples, run__$(shell_script_name), and run__$(python_script_name) Examples: ``` % make run-examples % make run__iss_cli.sh % make run__iss_pipeline.py ```
* adds gitignore keys for the output of sphinx-gallery, which are incorporated into the documentation in the source directory * adds additional galleries to docs/conf.py to render each of the data formatting examples and what were previously the notebooks * Does NOT remove the notebooks, but they can be removed once they are properly tested in their new .py form/home. * Makes minimal changes to the .py files to add docstrings to each data formatting and data processing example. These docstrings are needed by sphinx-gallery to add references to each file's header such that they can be linked to by the documentation. * Adds several WIP vignettes about how to use starfish to create an image processing pipeline * New makefile targets: run-examples, run__$(shell_script_name), and run__$(python_script_name) Examples: ``` % make run-examples % make run__iss_cli.sh % make run__iss_pipeline.py ```
The good:
gitignore
keys for the output of sphinx-gallery, which are incorporated into the documentation in the source directorydocs/conf.py
to render each of the data formatting examples and what were previously the notebooks.py
form/home.The bad:
Testing strategy:
Current state of testing of code in docs:
docs/source/_static/tutorials/exec_*
. Anything in a folder specified bydocs/source/conf.py
that begins withexec_
is run bysphinx-gallery
and therefore any errors in those .py files are caught by our existing CI, since the docs are built by travis.TileFetcher
scripts) are not currently tested and have been moved todocs/source/_static/data_formatting_scripts/
. They are not prefixed byexec_
and therefore continue to not be tested. It's not clear if we want to test these.docs/source/_static/data_processing_examples/
. They were previously tested but are no longer being tested under CI. Ideally we would have travis build them, then upload the results to readthedocs. For the time being it is adequate to simply have travis build them so they are checked for errors. This probably means updating the makefile target.Status of documentation added in this PR:
Edit: also disables the bootstrap theme for the time being. We can put it back later, but it was doing some weird things to some of the gallery stuff.