RST Error messages dump file

24 views
Skip to first unread message

amue...@ais.uni-bonn.de

unread,
Jun 2, 2012, 4:05:46 PM6/2/12
to sphinx-dev
Hi everybody.
When building the doc for scikit-learn, I have often problems
diagnosing error messages.
One of the main causes for that is that whenever a rst error occurs,
the complete generated file is dumped as a list
of unicode strings.
This makes the errors pretty unreadable. Also, the line numbers in the
errors correspond to lines inside the generated file, not inside the
source file, making the lines (and also files) hard to find.

Is this a known issue or the result of some misconfiguration?

What I would like to have as error output is just a line stating the
error and the line and source file the error occurred in.

Any help would be appreciated since I wasted hours in trying to
correct errors in our docs.

Cheers,
Andy

pstephens

unread,
Jan 15, 2014, 1:26:42 PM1/15/14
to sphinx...@googlegroups.com, sphinx-dev
Me too. 

Does anyone have a tool or method of identifying the cause of the error?

Thanks!

Purnank H. G.

unread,
Jan 16, 2014, 11:36:16 AM1/16/14
to sphinx...@googlegroups.com, sphinx-dev
I think the problem may be because of contents of rst_prolog  (http://sphinx-doc.org/config.html#confval-rst_prolog)

Philip Stephens

unread,
Jan 16, 2014, 12:34:54 PM1/16/14
to sphinx...@googlegroups.com, sphinx-dev
I don’t have a ‘rst_prolog’ declaration in my conf.py. 

But yesterday I switched from using numpydoc to the sphinx-contrib extension napoleon and now all those unicode docstrings are gone, and only relevant error messages are printed to screen. 

-- 
Philip Stephens
School of Geographical Sciences and Urban Planning
Arizona State University

 

Always have your stuff when you need it with @Dropbox. 2GB account is free! http://db.tt/pM4ytuK
--
You received this message because you are subscribed to a topic in the Google Groups "sphinx-users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/sphinx-users/7__mtNYogPk/unsubscribe.
To unsubscribe from this group and all its topics, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

Reply all
Reply to author
Forward
0 new messages