Issue 22251: Various markup errors in documentation (original) (raw)

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/66447

classification

process

Created on 2014-08-22 15:59 by berker.peksag, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (7)
msg225682 - (view)	Author: Berker Peksag (berker.peksag) *	Date: 2014-08-22 15:59
/home/berker/projects/cpython/default/Doc/extending/newtypes.rst:985: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/faq/library.rst:700: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/argparse.rst:1896: ERROR: Error in "warning" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/asyncio-eventloop.rst:200: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/asyncio-protocol.rst:397: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/asyncio-protocol.rst:405: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/asyncio-task.rst:271: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/email.contentmanager.rst:404: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/logging.handlers.rst:867: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/multiprocessing.rst:853: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/os.rst:59: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/pathlib.rst:34: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/pathlib.rst:40: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/pathlib.rst:43: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/pickle.rst:143: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/ssl.rst:269: ERROR: Error in "note" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/ssl.rst:934: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/statistics.rst:138: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/stdtypes.rst:3874: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/sys.rst:800: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/library/warnings.rst:43: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/using/cmdline.rst:109: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/using/cmdline.rst:161: ERROR: Error in "seealso" directive: invalid option block. /home/berker/projects/cpython/default/Doc/using/cmdline.rst:364: ERROR: Error in "seealso" directive: invalid option block.
msg227723 - (view)	Author: Roundup Robot (python-dev)	Date: 2014-09-27 20:22
New changeset 0ec56e677bc3 by Berker Peksag in branch '3.4': Issue #22251: Fix ReST markup to avoid errors building docs. https://hg.python.org/cpython/rev/0ec56e677bc3 New changeset ed1dbac90b92 by Berker Peksag in branch 'default': Issue #22251: Fix ReST markup to avoid errors building docs. https://hg.python.org/cpython/rev/ed1dbac90b92
msg227724 - (view)	Author: Berker Peksag (berker.peksag) *	Date: 2014-09-27 20:24
See issue 16805 for a similar issue.
msg227725 - (view)	Author: Georg Brandl (georg.brandl) *	Date: 2014-09-27 20:24
These "errors" are all valid markup. They would have been discovered much earlier had they been errors. Please consider checking why your Sphinx setup produces the errors, fixing it and then reverting the changes.
msg227726 - (view)	Author: R. David Murray (r.david.murray) *	Date: 2014-09-27 20:42
I suppose this is one disadvantage of using the system sphinx when 'make html' is run?
msg227729 - (view)	Author: Roundup Robot (python-dev)	Date: 2014-09-27 21:01
New changeset 0b84904c9471 by Berker Peksag in branch '3.4': Revert #22251 https://hg.python.org/cpython/rev/0b84904c9471 New changeset 78ae78f967f1 by Berker Peksag in branch 'default': Revert #22251 https://hg.python.org/cpython/rev/78ae78f967f1
msg227730 - (view)	Author: Berker Peksag (berker.peksag) *	Date: 2014-09-27 21:03
I was using Sphinx 1.2.2 and found two related issues: issue 16805 and issue 20961. I've just upgraded Sphinx to 1.2.3, did a clean checkout, reverted the changes and everything looks good. Sorry for the noise!