arifgursel / pyglet

Automatically exported from code.google.com/p/pyglet
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

spurious 'class plain' showing in sphinx rendering of doc/programming_guide/text.txt #734

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Look at
http://pyglet.org/doc-current/programming_guide/text.html#id9

(or the corresponding place in a fresh rendered pyglet docs, like from 
r9781eb46dca2 , April 3 2014)

A little below you can see a literal block preceded by a spurious 'class: 
plain' (see image using_class.png)

The related snippet in doc/programming_guide/text.txt goes by

"""
The following example shows a simple attributed text encoded document:

.. class:: plain

  ::

    Chapter 1

    My father's family name being Pirrip, and my Christian name Philip,
"""

Replacing 'class' with 'rst-class' is probably what is wanted, see image 
using_rst-class.png

Reference:
http://rest-sphinx-memo.readthedocs.org/en/latest/Sphinx.html#sphinx-directives
(search the page for rst-class)

There are more instances of this behavior in text.txt , and probably in other 
files of programming guide.

Original issue reported on code.google.com by ccanepacc@gmail.com on 12 Apr 2014 at 3:01

Attachments:

GoogleCodeExporter commented 9 years ago

Original comment by useboxnet on 13 Apr 2014 at 6:51

GoogleCodeExporter commented 9 years ago
I made the change but I get the same rendered HTML. I'm using sphinx 1.1.3 to 
generate the docs.

Original comment by useboxnet on 13 Apr 2014 at 7:06

GoogleCodeExporter commented 9 years ago
I used sphinx 1.2.2.
'clean' and 'html', sometimes sphinx is reluctant to overwrite files.

Original comment by ccanepacc@gmail.com on 13 Apr 2014 at 3:20

GoogleCodeExporter commented 9 years ago
Done a search for .. class:: plain under pyglet/doc , all the hits are in 
text.txt
Replaced all of '.. class:: plain' with '.. rst-class:: plain'
Rebuilt the docs (clean + html), with sphinx 1.2.2
Page looks good.

patch attached.

Original comment by ccanepacc@gmail.com on 14 Apr 2014 at 4:39

Attachments:

GoogleCodeExporter commented 9 years ago
OK, I'll give it a go to the patch but I did make clean && make html ;)

Original comment by useboxnet on 14 Apr 2014 at 5:51

GoogleCodeExporter commented 9 years ago
It makes no difference in 1.1.3 :( Anyway, I upgraded and it seems to be OK!

I updated the online version of the docs:

http://pyglet.org/doc-current/programming_guide/text.html#attributed-text

Thanks for the patch Claudio!

Original comment by useboxnet on 17 Apr 2014 at 5:15

GoogleCodeExporter commented 9 years ago
This issue was closed by revision 84b91037d876.

Original comment by useboxnet on 17 Apr 2014 at 5:16