Skip to content

FIX sphinx warnings #222

New issue
New issue
Open
Open
FIX sphinx warnings#222
Labels
documentationhelp wanted
@agramfort

Description

@agramfort
agramfort
opened on Dec 22, 2020

building the doc with:

make html-noplot

generates many warnings:

/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.barycenter_sinkhorn:38: WARNING: Duplicate explicit target name: "3".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.barycenter_stabilized:41: WARNING: Duplicate explicit target name: "3".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.convolutional_barycenter2d:40: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn:14: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn2:15: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn2:56: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn2:58: WARNING: Duplicate explicit target name: "9".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn2:60: WARNING: Duplicate explicit target name: "10".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn_divergence:34: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.greenkhorn:21: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.greenkhorn:60: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn:13: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn:47: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn:72: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn:74: WARNING: Duplicate explicit target name: "9".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn:76: WARNING: Duplicate explicit target name: "10".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn2:13: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn2:47: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn2:71: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn2:73: WARNING: Duplicate explicit target name: "9".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn2:75: WARNING: Duplicate explicit target name: "10".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_epsilon_scaling:14: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_epsilon_scaling:66: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_epsilon_scaling:68: WARNING: Duplicate explicit target name: "9".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_knopp:13: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_knopp:55: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:13: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:61: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:63: WARNING: Duplicate explicit target name: "9".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:65: WARNING: Duplicate explicit target name: "10".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.unmix:18: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.empirical_sinkhorn_divergence:75: WARNING: Footnote [23] is not referenced.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.jcpot_barycenter:50: WARNING: Footnote [27] is not referenced.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.screenkhorn:62: WARNING: Footnote [26] is not referenced.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.unmix:53: WARNING: Footnote [4] is not referenced.
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.barycenter:14: WARNING: Duplicate target name, cannot be used as a unique reference: "3".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.barycenter_sinkhorn:14: WARNING: Duplicate target name, cannot be used as a unique reference: "3".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.barycenter_stabilized:15: WARNING: Duplicate target name, cannot be used as a unique reference: "3".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn:19: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn2:19: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_epsilon_scaling:21: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_epsilon_scaling:21: WARNING: Duplicate target name, cannot be used as a unique reference: "10".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_epsilon_scaling:21: WARNING: Duplicate target name, cannot be used as a unique reference: "9".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_knopp:19: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:20: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:20: WARNING: Duplicate target name, cannot be used as a unique reference: "10".
/Users/alex/work/src/POT/ot/bregman.py:docstring of ot.bregman.sinkhorn_stabilized:20: WARNING: Duplicate target name, cannot be used as a unique reference: "9".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd:12: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd2:11: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd2:60: WARNING: Duplicate explicit target name: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd2_1d:11: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd2_1d:66: WARNING: Duplicate explicit target name: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd_1d:11: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd_1d:67: WARNING: Duplicate explicit target name: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.free_support_barycenter:42: WARNING: Duplicate explicit target name: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.wasserstein_1d:49: WARNING: Duplicate explicit target name: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.free_support_barycenter:44: WARNING: Footnote [2] is not referenced.
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd:21: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd2:20: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd2_1d:19: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.emd_1d:19: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
/Users/alex/work/src/POT/ot/lp/__init__.py:docstring of ot.lp.wasserstein_1d:16: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.cg:13: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.gcg:13: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.solve_1d_linesearch_quad:3: WARNING: Unexpected indentation.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.solve_linesearch:13: WARNING: Unexpected indentation.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.solve_linesearch:14: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.solve_linesearch:36: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.gcg:53: WARNING: Footnote [5] is not referenced.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.gcg:54: WARNING: Footnote [7] is not referenced.
/Users/alex/work/src/POT/ot/optim.py:docstring of ot.optim.solve_linesearch:34: WARNING: Footnote [24] is not referenced.
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.projection_simplex:4: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_semi_dual:50: WARNING: Duplicate explicit target name: "2".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_semi_dual:52: WARNING: Duplicate explicit target name: "17".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_dual:3: WARNING: Duplicate target name, cannot be used as a unique reference: "17".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_dual:14: WARNING: Duplicate target name, cannot be used as a unique reference: "17".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_dual:28: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_semi_dual:3: WARNING: Duplicate target name, cannot be used as a unique reference: "17".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_semi_dual:17: WARNING: Duplicate target name, cannot be used as a unique reference: "17".
/Users/alex/work/src/POT/ot/smooth.py:docstring of ot.smooth.smooth_ot_semi_dual:30: WARNING: Duplicate target name, cannot be used as a unique reference: "2".
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.solve_semi_dual_entropic:20: WARNING: Bullet list ends without a blank line; unexpected unindent.
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.averaged_sgd_entropic_transport:20: WARNING: Unknown target name: "18".
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.batch_grad_dual:21: WARNING: Unknown target name: "19".
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.c_transform_entropic:15: WARNING: Unknown target name: "18".
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.coordinate_grad_semi_dual:15: WARNING: Unknown target name: "18".
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.sag_entropic_transport:21: WARNING: Unknown target name: "18".
/Users/alex/work/src/POT/ot/stochastic.py:docstring of ot.stochastic.solve_semi_dual_entropic:20: WARNING: Unknown target name: "18".

it would be great to fix them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationhelp wanted

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions