Autoscoper Read the Docs #117
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as resolved.
This comment was marked as resolved.
NicerNewerCar
force-pushed
the
read-the-docs
branch
from
c35765f to
7cabe79
Compare
Closed
NicerNewerCar
force-pushed
the
read-the-docs
branch
2 times, most recently
from
d6ba22e to
e27673c
Compare
jcfr
reviewed
Apr 10, 2023
NicerNewerCar
force-pushed
the
read-the-docs
branch
2 times, most recently
from
dddc69e to
8348af0
Compare
This comment was marked as resolved.
This comment was marked as resolved.
NicerNewerCar
force-pushed
the
read-the-docs
branch
from
5befec7 to
3690c32
Compare
NicerNewerCar
force-pushed
the
read-the-docs
branch
2 times, most recently
from
e48b85d to
c808927
Compare
This comment was marked as resolved.
This comment was marked as resolved.
NicerNewerCar
force-pushed
the
read-the-docs
branch
3 times, most recently
from
e2a7146 to
cb7d457
Compare
This comment was marked as resolved.
This comment was marked as resolved.
NicerNewerCar
force-pushed
the
read-the-docs
branch
4 times, most recently
from
ca97d98 to
fbba0c7
Compare
jcfr
reviewed
May 25, 2023
jcfr
reviewed
May 25, 2023
NicerNewerCar
force-pushed
the
read-the-docs
branch
from
fbba0c7 to
f0f3787
Compare
|
Considering also adding a dependency to https://sphinx-design.readthedocs.io |
NicerNewerCar
force-pushed
the
read-the-docs
branch
3 times, most recently
from
d99f9ac to
e152cd8
Compare
This makes it easier to read the source. See https://google.github.io/styleguide/docguide/style.html#add-spacing-to-headings
This commit fixes the following warnings: /path/to/Autoscoper/CONTRIBUTING.md:19: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header] /path/to/Autoscoper/CONTRIBUTING.md:38: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header] /path/to/Autoscoper/CONTRIBUTING.md:47: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header] /path/to/Autoscoper/CONTRIBUTING.md:100: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header] /path/to/Autoscoper/CONTRIBUTING.md:116: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
This commit fixes warnings like the following: /path/to/Autoscoper/Documentation/tutorials/filters.md:5: WARNING: local id not found in doc 'user-interface': 'rendering-options' [myst.xref_missing] It also updates the `myst_heading_anchors` from `3` to `4` to fix the following warning: /path/to/Autoscoper/Documentation/tutorials/sample-data.md:71: WARNING: local id not found in doc 'user-interface': 'importexport-tracking-options' [myst.xref_missing]
Since warning have effectively been fixed, this commit removes the invalid option "supress_warnings". It should have been "suppress_warnings" See https://myst-parser.readthedocs.io/en/latest/configuration.html#build-warnings
This commit fixes the following warning: /path/to/Autoscoper/Documentation/file-specifications/camera-calibration.md:80: WARNING: Pygments lexer name 'linenos' is not known References: * https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html#parameterizing-directives * https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block * https://myst-parser.readthedocs.io/en/latest/configuration.html#global-configuration
NicerNewerCar
force-pushed
the
read-the-docs
branch
from
64fe63a to
26acace
Compare
NicerNewerCar
force-pushed
the
read-the-docs
branch
4 times, most recently
from
1648099 to
24aa19a
Compare
NicerNewerCar
force-pushed
the
read-the-docs
branch
from
24aa19a to
740bcb3
Compare
jcfr
reviewed
Jun 14, 2023
The UI component is now consistent with the remaining of the application $ ack "\>OK" autoscoper/src/ui/ui-files/NewTrialDialog.ui 27: <string>OK</string> autoscoper/src/ui/ui-files/TrackingOptionsDialog.ui 65: <string>OK</string> autoscoper/src/ui/ui-files/ImportExportTrackingOptionsDialog.ui 418: <string>OK</string> autoscoper/src/ui/ui-files/OpenCLPlatformSelectDialog.ui 45: <string>OK</string>
Also update references to button name from "Ok" to "OK"
- use warning/seealso/tip admonitions - add additional empty line
Consistently uses the term AutocoperM
jcfr
approved these changes
Jun 14, 2023
There was a problem hiding this comment.
Thanks @NicerNewerCar for putting together the documentation and thanks @amymmorton for the review 💯 🙏
🚀
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request for setting up an RTD page for Autoscoper.
For future reference, see this page in the RTD documentation for setting up webhooks.
Documentation generated for this PR
Once this is merged into main
PR #11in theautoscoperm.slicer.orgrepo should be merged in.Closes #127
TODO
Add Click to enlarge for images -> from AmyExpanded content width to 100%