Skip to content

Commit 37fa225

Browse files
thewtexthewtex
committed
COMP: Address various Sphinx warnings
ITKExamples-build/src/Core/Common/InPlaceFilterOfImage/Documentation.rst:25: WARNING: Explicit markup ends without a blank line; unexpected unindent. flag Build Log Line 9372 Warning ITKExamples-build/src/Core/ImageFunction/ResampleSegmentedImage/Documentation.rst:20: WARNING: image file not readable: src/Core/ImageFunction/ResampleSegmentedImage/Yinyang.png flag Build Log Line 9373 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:36: WARNING: Unexpected indentation. flag Build Log Line 9374 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:38: WARNING: Block quote ends without a blank line; unexpected unindent. flag Build Log Line 9375 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:41: WARNING: Definition list ends without a blank line; unexpected unindent. flag Build Log Line 9376 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:62: WARNING: doxygenclass: Cannot find class "itk::GradientDescentOptimizerv4" in doxygen xml output for project "ITK" from directory: /.../ITKExamples/ITKExamples-build/ITKDoxygenXML looking for now-outdated files... none found pickling environment... done Build Log Line 9379 Warning checking consistency... /.../ITKExamples/ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst: WARNING: document isn't included in any toctree done preparing documents... done writing output... [ 0%] Documentation/Build/index (line 6) ok https://www.python.org/ (line 6) ok https://brew.sh/ (line 22) ok https://itk.org/ITKExamples/src/Filtering/BinaryMathematicalMorphology/DilateABinaryImage/Documentation.html (line 132) ok https://cmake.org/ (line 6) redirect https://www.anaconda.com/distribution - permanently to https://www.anaconda.com/products/individual (line 168) ok https://www.slicer.org/ flag Build Log Line 12906 Warning reading sources... [ 98%] src/Segmentation/Voronoi/index reading sources... [ 98%] src/Segmentation/Watersheds/MorphologicalWatershedSegmentation/Documentation reading sources... [ 98%] src/Segmentation/Watersheds/SegmentWithWatershedImageFilter/Documentation reading sources... [ 98%] src/Segmentation/Watersheds/index reading sources... [ 99%] src/Segmentation/index reading sources... [ 99%] src/Video/BridgeOpenCV/ConvertAnITKGrayScaleImageToCVMat/Documentation reading sources... [ 99%] src/Video/BridgeOpenCV/index reading sources... [ 99%] src/Video/index reading sources... [100%] src/index ITKExamples-build/src/Core/Common/InPlaceFilterOfImage/Documentation.rst:25: WARNING: Explicit markup ends without a blank line; unexpected unindent. flag Build Log Line 12907 Warning ITKExamples-build/src/Core/ImageFunction/ResampleSegmentedImage/Documentation.rst:20: WARNING: image file not readable: src/Core/ImageFunction/ResampleSegmentedImage/Yinyang.png flag Build Log Line 12908 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:36: WARNING: Unexpected indentation. flag Build Log Line 12909 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:38: WARNING: Block quote ends without a blank line; unexpected unindent. flag Build Log Line 12910 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:41: WARNING: Definition list ends without a blank line; unexpected unindent. flag Build Log Line 12911 Warning ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst:62: WARNING: doxygenclass: Cannot find class "itk::GradientDescentOptimizerv4" in doxygen xml output for project "ITK" from directory: /.../ITKExamples/ITKExamples-build/ITKDoxygenXML looking for now-outdated files... none found pickling environment... done Build Log Line 12914 Warning checking consistency... /.../ITKExamples/ITKExamples-build/src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst: WARNING: document isn't included in any toctree done preparing documents... done writing output... [ 0%] Documentation/Build/index writing output... [ 0%] Documentation/Contribute/ContributeWithGit writing output... [ 0%] Documentation/Contribute/DashboardSubmission writing output... [ 0%] Documentation/Contribute/PeerReviewWithGitHub writing output... [ 1%] Documentation/Contribute/UploadBinaryData writing output... [ 1%] Documentation/Contribute/WriteANewExample writing output... [ 1%] Documentation/Contribute/index writing output... [ 1%] Documentation/Credits flag Build Log Line 13413 Warning writing output... [ 98%] src/Segmentation/Voronoi/index writing output... [ 98%] src/Segmentation/Watersheds/MorphologicalWatershedSegmentation/Documentation writing output... [ 98%] src/Segmentation/Watersheds/SegmentWithWatershedImageFilter/Documentation writing output... [ 98%] src/Segmentation/Watersheds/index writing output... [ 99%] src/Segmentation/index writing output... [ 99%] src/Video/BridgeOpenCV/ConvertAnITKGrayScaleImageToCVMat/Documentation writing output... [ 99%] src/Video/BridgeOpenCV/index writing output... [ 99%] src/Video/index writing output... [100%] src/index ITKExamples-build/src/Core/ImageFunction/ResampleSegmentedImage/Documentation.rst:20: WARNING: Could not obtain image size. :scale: option is ignored. Build Log Line 13414 Warning /.../ITKExamples/ITKExamples-build/src/Core/Transform/MutualInformationAffine/Documentation.rst:: WARNING: Could not obtain image size. :scale: option is ignored. flag Build Log Line 13415 Warning ITKExamples-build/src/Numerics/Optimizers/ExhaustiveOptimizer/Documentation.rst:33: WARNING: Could not lex literal_block as "c++". Highlighting skipped.
1 parent c60556b commit 37fa225

File tree

8 files changed

+38
-32
lines changed

8 files changed

+38
-32
lines changed

‎src/Core/Common/InPlaceFilterOfImage/Documentation.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Results
2222
:alt: QuickView output.
2323

2424
Output In QuickView
25+
2526
Code
2627
----
2728

‎src/Core/ImageFunction/ResampleSegmentedImage/Documentation.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ Resample (stretch or compress) a segmented image.
1313

1414
Results
1515
-------
16-
.. figure:: Yinyang.png
16+
17+
.. figure:: Gourds.png
1718
:scale: 50%
18-
:alt: Input yin-yang image.
19+
:alt: Input image.
1920

2021
Input Image
2122

‎src/Core/Transform/MutualInformationAffine/Documentation.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,21 @@ Global registration by maximizing the mutual information and using an affine tra
1414

1515
Results
1616
-------
17+
1718
.. figure:: fixed.png
18-
:scale: 70%
1919
:alt: fixed.png
2020

21-
fixed.png
21+
fixed.png
2222

2323
.. figure:: moving.png
24-
:scale: 70%
2524
:alt: moving.png
2625

27-
moving.png
26+
moving.png
2827

2928
.. figure:: OutputBaseline.png
30-
:scale: 70%
3129
:alt: OutputBaseline.png
3230

33-
OutputBaseline.png
31+
OutputBaseline.png
3432

3533
Output::
3634

‎src/Core/Transform/MutualInformationAffine/OutputBaseline.png

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎src/Core/Transform/MutualInformationAffine/OutputBaseline.png.sha512

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
46a0c840567a4eee4a3150674d78fecf7d0395c61c7de697218c0b408919587e4a39f7c307b7bbe144613e0c72bf8eb45f3f59a6b140f1b443bffa0a611aae1e

‎src/Numerics/Optimizers/ExhaustiveOptimizer/Documentation.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ An optimizer that fully samples a grid on the parametric space.
1212

1313
Results
1414
-------
15+
1516
.. note::
1617
**Help Wanted**
1718
Implementation of Results for sphinx examples containing this message.
@@ -28,10 +29,11 @@ C++
2829
:lines: 18-
2930

3031
Python
31-
...
32+
......
3233

3334
.. literalinclude:: Code.py
34-
:lines: 20-
35+
:language: python
36+
:lines: 20-
3537

3638
Jupyter Notebook
3739
-----------------

‎src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,33 @@ Index
1515
Synopsis
1616
--------
1717

18-
Register two point sets with the Jensen-Havrda-Charvat-Tsallis point set
18+
Register two point sets with the Jensen-Havrda-Charvat-Tsallis point set
1919
metric.
2020

2121
Results
2222
--------
23-
It: 0 metric value: -0.0641355
24-
It: 1 metric value: -0.0955508
25-
It: 2 metric value: -0.0956365
26-
It: 3 metric value: -0.0956648
27-
It: 4 metric value: -0.0956742
28-
It: 5 metric value: -0.0956774
29-
It: 6 metric value: -0.0956784
30-
It: 7 metric value: -0.0956788
31-
It: 8 metric value: -0.0956789
32-
It: 9 metric value: -0.0956789
33-
numberOfIterations: 10
34-
Moving-source final value: -0.0956789
35-
Moving-source final position: [0.9999999481711049, 3.6956646020565954e-9,
36-
-3.9958144654776e-8, 1.0000000021678688,
37-
1.9991709056354183, 1.999169080146488]
38-
Optimizer scales: [10000, 9998.46502472856,
39-
10000, 9998.46502472848,
40-
1.0000000000010232, 1.0000000000010232]
41-
Optimizer learning rate: 164.938
23+
24+
::
25+
26+
It: 0 metric value: -0.0641355
27+
It: 1 metric value: -0.0955508
28+
It: 2 metric value: -0.0956365
29+
It: 3 metric value: -0.0956648
30+
It: 4 metric value: -0.0956742
31+
It: 5 metric value: -0.0956774
32+
It: 6 metric value: -0.0956784
33+
It: 7 metric value: -0.0956788
34+
It: 8 metric value: -0.0956789
35+
It: 9 metric value: -0.0956789
36+
numberOfIterations: 10
37+
Moving-source final value: -0.0956789
38+
Moving-source final position: [0.9999999481711049, 3.6956646020565954e-9,
39+
-3.9958144654776e-8, 1.0000000021678688,
40+
1.9991709056354183, 1.999169080146488]
41+
Optimizer scales: [10000, 9998.46502472856,
42+
10000, 9998.46502472848,
43+
1.0000000000010232, 1.0000000000010232]
44+
Optimizer learning rate: 164.938
4245

4346
Code
4447
--------
@@ -59,4 +62,4 @@ Classes demonstrated
5962
--------------------
6063

6164
.. breathelink:: itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4
62-
.. breathelink:: itk::GradientDescentOptimizerv4
65+
.. breathelink:: itk::GradientDescentOptimizerv4Template

‎src/Registration/Metricsv4/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ Metricsv4
55
:maxdepth: 1
66

77
PerformRegistrationOnVectorImages/Documentation.rst
8+
RegisterTwoPointSets/Documentation.rst

0 commit comments

Comments
 (0)