yade-dev team mailing list archive
-
yade-dev team
-
Mailing list archive
-
Message #06589
[Bug 692759] [NEW] report yade errors during sphinx generation
Public bug reported:
Hi, while browsing through docs, you can stumble upon badly generated
examples of "how yade works", those examples include:
https://www.yade-dem.org/sphinx/prog.html#python-attribute-access
https://www.yade-dem.org/sphinx/prog.html#wrapping-c-classes
This bug report isn't about fixing those two examples, because there are
too many of them.
The idea is to instead detect yade runtime errors in sphinx generation
phase and report an error. Maybe even failing to compile documentation.
Simplest way, I think, is to add a command line option to yade which
tells it to exit(1) on first python error. Those exit(1)'s sphinx would
be able detect.
** Affects: yade
Importance: Undecided
Status: New
--
You received this bug notification because you are a member of Yade
developers, which is the registrant for Yade.
https://bugs.launchpad.net/bugs/692759
Title:
report yade errors during sphinx generation
Status in Yet Another Dynamic Engine:
New
Bug description:
Hi, while browsing through docs, you can stumble upon badly generated examples of "how yade works", those examples include:
https://www.yade-dem.org/sphinx/prog.html#python-attribute-access
https://www.yade-dem.org/sphinx/prog.html#wrapping-c-classes
This bug report isn't about fixing those two examples, because there are too many of them.
The idea is to instead detect yade runtime errors in sphinx generation phase and report an error. Maybe even failing to compile documentation. Simplest way, I think, is to add a command line option to yade which tells it to exit(1) on first python error. Those exit(1)'s sphinx would be able detect.
Follow ups
References