docutils-users Mailing List for Docutils: Documentation Utilities

Hi,

When switching from "html" to "html5" writer, I got the following
problem: the docinfo is now included in the "body" parts when using
"publish_parts".

For details see my question of StackOverflow:
https://stackoverflow.com/q/50423279/3025740

As I say in StackOverflow it seems to contradict the documentation
which says that "body" should not contain the docinfo.

Searching in docutils mailing list, I found this message suggesting to
use "strip_elements_with_classes":
https://sourceforge.net/p/docutils/mailman/message/35973538/

But it does not seem to work for me.

Code example:

    import docutils.core

    SOURCE = '''\
    :key: value

    Title
    ========

    Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
nonumy eirmod
    tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
voluptua. At
    vero eos et accusam et justo duo dolores et ea rebum. Stet clita
kasd gubergren,
    no sea takimata sanctus est Lorem ipsum dolor sit amet.
    '''

    docutils_params = {
        'input_encoding': 'utf-8',
        'strip_elements_with_classes': ['docinfo simple']
    }

    body = docutils.core.publish_parts(
        SOURCE,
        writer_name='html5',
        settings_overrides=docutils_params
    )['body']

    print(body)

(using Python 3)

Any idea ?

-- 
Cédric Van Rompay

Le 07/05/2018 à 08:22, Nicolas Rougier a écrit :
> Hi all,
>
> I just released an open-access book on "Python & OpenGL for Scientific Visualization” (http://www.labri.fr/perso/nrougier/python-opengl/).
>
> The book has been written using rst and I wrote a slightly modified rst2html and a css to give the book a modern look (IMHO). Code is available at https://github.com/rougier/python-opengl.
>
Hello,

I just want to say that your work is amazing. As much on the form as on 
the content.

Can you explain what changed did you do in the rst2html code ?

Thanks.

I mostly modified the code to take movies into account (both in image and figure directive) with some options.
I wanted to be able to write something like:

```
.. figure:: movies/chapter-05/color-cube.mp4
   :loop:
   :autoplay:
   :controls:
   :figwidth: 35%
            
   Figure

   The RGB rotating cube 
```
   

The code is here: https://github.com/rougier/python-opengl/blob/master/rst2html.py

Nicolas


> On 24 May 2018, at 20:44, seb...@ch... wrote:
> 
> 
> 
> Le 07/05/2018 à 08:22, Nicolas Rougier a écrit :
>> Hi all,
>> 
>> I just released an open-access book on "Python & OpenGL for Scientific Visualization” (http://www.labri.fr/perso/nrougier/python-opengl/).
>> 
>> The book has been written using rst and I wrote a slightly modified rst2html and a css to give the book a modern look (IMHO). Code is available at https://github.com/rougier/python-opengl.
>> 
> Hello,
> 
> I just want to say that your work is amazing. As much on the form as on the content.
> 
> Can you explain what changed did you do in the rst2html code ?

Hi all,

I just released an open-access book on "Python & OpenGL for Scientific Visualization” (http://www.labri.fr/perso/nrougier/python-opengl/). 

The book has been written using rst and I wrote a slightly modified rst2html and a css to give the book a modern look (IMHO). Code is available at https://github.com/rougier/python-opengl.


Nicolas

On Wed, Feb 15 2017, Alan Isaac wrote:
> Might consideration be given to adding a `kbd` standard role?

I'd like to resurrect this thread.

Github added `kbd` as a standard role for documentation purposes, since
it's very frequently used in READMEs along with code sections. They
translate it into <kbd> tags in the html writer.

Now I'm a bit thorn if I should add a non-standard role into my READMEs
just to have fancier formatting.

I admit, I'd use `kbd` quit a bit too. I write almost everything in rst
these days, and showing "stuff to type" scores pretty high for me.