Fix docstring markup in sage/combinat

[kwankyu]

Part of #34157:

sage/combinat/ranker.py:153:1: RST303 Unknown directive type "todo".
sage/combinat/tableau_tuple.py:3:1: RST214 Inline literal start-string without end-string.
sage/combinat/set_partition.py:2922:1: RST304 Unknown interpreted text role "cls".
sage/combinat/parallelogram_polyomino.py:430:1: RST213 Inline emphasis start-string without end-string.
sage/combinat/parallelogram_polyomino.py:430:1: RST210 Inline strong start-string without end-string.
sage/combinat/parallelogram_polyomino.py:1640:1: RST301 Unexpected indentation.
sage/combinat/parallelogram_polyomino.py:1642:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/combinat/parallelogram_polyomino.py:1661:1: RST207 Literal block ends without a blank line; unexpected unindent.
sage/combinat/tutorial.py:20:1: RST303 Unknown directive type "todo".
sage/combinat/tutorial.py:457:1: RST303 Unknown directive type "todo".
sage/combinat/tutorial.py:1143:1: RST303 Unknown directive type "todo".
sage/combinat/counting.py:2:1: RST399 Document or section may not begin with a transition.
sage/combinat/designs/database.py:20:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/combinat/designs/database.py:25:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/combinat/designs/database.py:28:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/combinat/designs/database.py:31:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/combinat/designs/database.py:37:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/combinat/sf/jack.py:655:1: RST303 Unknown directive type "todo".
sage/combinat/sf/sf.py:46:1: RST303 Unknown directive type "MODULEAUTHOR".
sage/combinat/posets/linear_extensions.py:99:1: RST303 Unknown directive type "todo".
sage/combinat/posets/linear_extensions.py:656:1: RST303 Unknown directive type "todo".
sage/combinat/crystals/all.py:17:1: RST214 Inline literal start-string without end-string.
sage/combinat/ncsf_qsym/generic_basis_code.py:108:1: RST303 Unknown directive type "todo".
sage/combinat/words/suffix_trees.py:1747:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/combinat/root_system/root_lattice_realizations.py:1283:1: RST303 Unknown directive type "todo".
sage/combinat/root_system/weight_space.py:464:1: RST303 Unknown directive type "todo".
sage/combinat/root_system/root_space.py:182:1: RST303 Unknown directive type "todo".

Depends on #34167
Depends on #34172

CC: @tscrim

Component: documentation

Author: Matthias Koeppe

Branch/Commit: 579f381

Reviewer: John Palmieri

Issue created by migration from https://trac.sagemath.org/ticket/34171

[fchapoton]

comment:2

the warnings in designs are not true errors (dynamic filling of the doc) so will have to be excluded somehow

[jhpalmieri]

comment:4

Maybe just exclude the file designs/database.py, like sagemath/sagetrac-mirror@5da5e1f (on top of #30448)?

[mkoeppe]

Dependencies: #34167

[mkoeppe]

Branch: u/mkoeppe/fix_docstring_markup_in_sage_combinat

[sagetrac-git]

Commit: 93f7e47

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

93f7e47

src/sage/combinat: Fix some warnings shown by ./sage -tox -e rst

[mkoeppe]

Author: Matthias Koeppe, ...

[mkoeppe]

comment:9

Replying to @jhpalmieri:

Maybe just exclude the file designs/database.py, like sagemath/sagetrac-mirror@5da5e1f (on top of #30448)?

Yes, probably the best solution

[mkoeppe]

Changed dependencies from #34167 to #34167, #34172

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

0794103	trac 34172: doc markup fixes for groups, misc
56f5a50	Merge branch 't/30448/public/30448' into t/34172/misc-doc-markup
5da5e1f	trac 34172: ignore misc/sagedoc.py when using flake8 to check rst markup
e52eb43	Merge #34172
699325e	src/tox.ini (rst): Exclude sage/combinat/designs/database.py

[sagetrac-git]

Changed commit from 93f7e47 to 699325e

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

d511048

src/sage/combinat/parallelogram_polyomino.py: Fix doctest markup

[sagetrac-git]

Changed commit from 699325e to d511048

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

9d298f5

src/sage/combinat/counting.py: Work around remaining flake8-rst-docstrings first-line issue

[sagetrac-git]

Changed commit from d511048 to 9d298f5

[mkoeppe]

Changed author from Matthias Koeppe, ... to Matthias Koeppe

[jhpalmieri]

comment:16

Documentation fails to build. I see

src/doc/en/reference/combinat/sage/combinat/counting.rst:6: WARNING: Explicit markup ends without a blank line; unexpected unindent.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

579f381

src/sage/combinat/counting.py: Change markup so it works with docbuild and rst linter

[sagetrac-git]

Changed commit from 9d298f5 to 579f381

[mkoeppe]

comment:18

now it builds

[jhpalmieri]

comment:19

Docs build, tests pass, linter is happy.

[jhpalmieri]

Reviewer: John Palmieri

[mkoeppe]

comment:20

Thanks!

[vbraun]

Changed branch from u/mkoeppe/fix_docstring_markup_in_sage_combinat to 579f381