Keep going in doc errors

[vbraun]

$ sage -docbuild -h
Usage: sage -docbuild [OPTIONS] DOCUMENT (FORMAT | COMMAND)

[...]

  Advanced:
    Use these options with care.

    -S OPTS, --sphinx-opts=OPTS
                        pass comma-separated OPTS to sphinx-build
    -U, --update-mtimes
                        before building reference manual, update modification
                        times for auto-generated ReST files
    -k, --keep-going    Do not abort on errors but continue as much as
                        possible after an error

CC: @nathanncohen @jhpalmieri

Component: documentation

Keywords: days57

Author: Volker Braun

Branch/Commit: 1e7bc36

Reviewer: Nicolas M. Thiéry

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

[nthiery]

Author: Volker Braun

[nthiery]

Reviewer: Nicolas M. Thiéry

[vbraun]

Branch: u/vbraun/keep_going_in_doc_errors

[vbraun]

Commit: 0e912bf

[vbraun]

New commits:

0e912bf

Add sage -docbuild -k option to keep going after errors

[vbraun]

Changed keywords from none to days57

[nathanncohen]

comment:5

AHahahah. Thank you Volker :-D

[nathanncohen]

comment:6

HMmmmmmm... I try to read and understand how it works, but it does not work for my own use yet. The "raise OSError" which is called when there is a broken link in a page is in custom-sphinx-build.py.

I added a commit for that in public/16100. Is that okay for you ? If it is I will look again at your commit and review it properly, i.e. try to understand it :-P

Nathann

[nthiery]

comment:7

Yup, Volker is working on that right now :-)

[nathanncohen]

comment:8

Well, short of this I agree with the commit. The only thing is that the "if ABORT_ON_ERROR:" added before the raise makes me wonder if anything is displayed when the exception is caught. Not having the exception is cool, thinking that nothing happened is something different :-P

And I do not know how to test that.

Unfortunately I have to leave right now, and I may not be near a computer for the next few days...

Thank you very much again, Volker ! I want to keep the links working, and this really helps to track them :-)

Nathann

[sagetrac-git]

Changed commit from 0e912bf to d51fa29

[sagetrac-git]

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

d51fa29

when aborting wait until the end of the source file

[vbraun]

comment:10

The actual error message consists of three lines and looks like

[geometry ] <autodoc>:0: ERROR: Unknown directive type "blah".
[geometry ] .. blah::
[geometry ] /home/vbraun/Code/sage/local/lib/python2.7/site-packages/sage/geometry/cone.py:docstring of sage.geometry.cone:0: ERROR: Unknown directive type "foo".

If we raise the error on the first error line then we lose the important information about the file that contains the error. The updated patch will spit out all error messages in the file before aborting (or not abort if you pass -k).

[sagetrac-git]

Changed commit from d51fa29 to 1e7bc36

[sagetrac-git]

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

1e7bc36

only print backtrace once

[vbraun]

comment:12

Nicolas reviewed the ticket

[vbraun]

Changed branch from u/vbraun/keep_going_in_doc_errors to 1e7bc36