Pydoc: Fix sphinx compile warnings about freestyle
ClosedPublic
Actions

Authored by Aaron Carlisle (Blendify) on Oct 11 2020, 6:44 PM.

Details

Reviewers

Commits

rBbaa24f1c91d2: Pydoc: Fix sphinx compile warnings about freestyle

Summary

Sphinx expects functions and methods with the same name and different
parameters to be written using one directive. See:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#basic-markup

Unfortunately this makes giving different descriptions for each harder.
This was already a request for better support for this in sphinx, see:
https://github.com/sphinx-doc/sphinx/issues/7787

Diff Detail

Repository: rB Blender

Event Timeline

Aaron Carlisle (Blendify) requested review of this revision.Oct 11 2020, 6:44 PM

Aaron Carlisle (Blendify) created this revision.

Harbormaster completed remote builds in B10673: Diff 29817.Oct 11 2020, 6:44 PM

Cleanup: Line splitting

Harbormaster completed remote builds in B10674: Diff 29818.Oct 11 2020, 6:53 PM

Cleanup: Make format

Harbormaster completed remote builds in B10675: Diff 29819.Oct 11 2020, 6:56 PM

Aaron Carlisle (Blendify) added a reviewer: Campbell Barton (campbellbarton).Oct 13 2020, 2:35 PM

Campbell Barton (campbellbarton) accepted this revision.Oct 16 2020, 11:33 AM

This revision is now accepted and ready to land.Oct 16 2020, 11:33 AM

Closed by commit rBbaa24f1c91d2: Pydoc: Fix sphinx compile warnings about freestyle (authored by Aaron Carlisle (Blendify)). · Explain WhyOct 22 2020, 11:28 PM

This revision was automatically updated to reflect the committed changes.

Aaron Carlisle (Blendify) added a commit: rBbaa24f1c91d2: Pydoc: Fix sphinx compile warnings about freestyle.

Revision Contents
Changeset List

Path

Size

source/

blender/

freestyle/

intern/

python/

17 lines

33 lines

183 lines

26 lines

BPy_StrokeAttribute.cpp

24 lines

BPy_ViewShape.cpp

14 lines

Interface0D/

BPy_CurvePoint.cpp

32 lines

BPy_SVertex.cpp

15 lines

CurvePoint/

BPy_StrokeVertex.cpp

35 lines

ViewVertex/

BPy_NonTVertex.cpp

30 lines

Interface1D/

13 lines

14 lines

28 lines

32 lines

Curve/

BPy_Chain.cpp

14 lines

FEdge/

BPy_FEdgeSharp.cpp

14 lines

BPy_FEdgeSmooth.cpp

14 lines

Iterator/

BPy_AdjacencyIterator.cpp

14 lines

BPy_ChainPredicateIterator.cpp

95 lines

BPy_ChainSilhouetteIterator.cpp

8 lines

BPy_ChainingIterator.cpp

12 lines

BPy_CurvePointIterator.cpp

14 lines

BPy_Interface0DIterator.cpp

10 lines

BPy_SVertexIterator.cpp

60 lines

BPy_StrokeVertexIterator.cpp

8 lines

BPy_ViewEdgeIterator.cpp

8 lines

BPy_orientedViewEdgeIterator.cpp

8 lines

UnaryFunction1D/

BPy_UnaryFunction1DDouble.cpp

9 lines

BPy_UnaryFunction1DEdgeNature.cpp

9 lines

BPy_UnaryFunction1DFloat.cpp

9 lines

BPy_UnaryFunction1DUnsigned.cpp

9 lines

BPy_UnaryFunction1DVec2f.cpp

9 lines

BPy_UnaryFunction1DVec3f.cpp

9 lines

BPy_UnaryFunction1DVectorViewShape.cpp

9 lines

BPy_UnaryFunction1DVoid.cpp

9 lines

Diff 30283

View Options

source/blender/freestyle/intern/python/BPy_FrsMaterial.cpp

View Options

source/blender/freestyle/intern/python/BPy_Id.cpp

View Options

source/blender/freestyle/intern/python/BPy_Operators.cpp

View Options

source/blender/freestyle/intern/python/BPy_SShape.cpp

View Options

source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp

View Options

source/blender/freestyle/intern/python/BPy_ViewShape.cpp

View Options

source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp

View Options

source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp

View Options

source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp

View Options

source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp

View Options

source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_ChainPredicateIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_ChainSilhouetteIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_ChainingIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_ViewEdgeIterator.cpp

View Options

source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp

View Options

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp

Pydoc: Fix sphinx compile warnings about freestyleClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 30283

source/blender/freestyle/intern/python/BPy_FrsMaterial.cpp

source/blender/freestyle/intern/python/BPy_Id.cpp

source/blender/freestyle/intern/python/BPy_Operators.cpp

source/blender/freestyle/intern/python/BPy_SShape.cpp

source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp

source/blender/freestyle/intern/python/BPy_ViewShape.cpp

source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp

source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp

source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp

source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp

source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp

source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp

source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp

source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp

source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp

source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp

source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp

source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_ChainPredicateIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_ChainSilhouetteIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_ChainingIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_ViewEdgeIterator.cpp

source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp

source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp

Pydoc: Fix sphinx compile warnings about freestyle
ClosedPublic
Actions

Revision Contents
Changeset List