Recent changes to support-requests

#6 What is the proper way to register transform settings?

2023-04-18T20:43:25.037000Z

The "clean" way would be a custom parser component.
Sub-classing docutils.parsers.rst.Parser is easy,
specifying the custom parser to the generic docutils CLI is easy, too,
the tricky part may be to convince Sphinx, Pelican, Nikola, etc. to use it.

What is the proper way to register transform settings?

2021-08-23T21:27:31.621000Z

I have a Python package that defines custom Docutils directives and roles. It does not need a custom reader, writer, or parser: it just uses directives.register_directive or roles.register_canonical_role. Then, it runs transforms registered using nodes.pending nodes.

These transforms take settings. What is the proper way to register them? One issue I'm running into is that although custom components can declare a settings_spec, transforms cannot.

When I'm calling docutils myself, it's easy to use the settings_spec provided by docutils.core.publish_*.

But when I'm calling docutils through Sphinx, Pelican, Nikola, etc, I don't have control on that parameter. So, what is the recommended way to tell Docutils about these additional settings? Should I override the settings_spec of the default OptionsParser?

#5 escaping smart quotes along with literal backslash inside

2020-09-08T14:24:48.576000Z

status: open --> closed

#4 How to programatically use the commandline parameters?

2020-09-08T14:20:46.850000Z

status: open --> closed

#5 escaping smart quotes along with literal backslash inside

2019-06-24T16:07:40.230000Z

The recommended method is to use inline literals like '\'.

The problem is that the escaping backslashes must reach the "smartquotes" transform. This means you need to double the escaping in case your rST source is in a Python string (e.g. a docstring) unless you use r"raw strings".
The next problem is that up to version 0.15, smartquotes need one more doubling of backslashes (see https://sourceforge.net/p/docutils/bugs/332/ and https://sourceforge.net/p/docutils/bugs/353/) so it might be "\'\\\'" or r"'\'". However, this will change in further Docutils versions.

escaping smart quotes along with literal backslash inside

2019-04-16T14:25:02.832000Z

I want to get '\' (a backslash within a pair of apostrophes) in html output without turnning off smartquotes funtionality. I tried to escape the apostrophes and backslash with \\'\\\\' but got '\’, where the ending apostrophe didn't get escaped. Anybody know how to sort it out?

escaping smart quotes along with literal backslash inside

2019-04-16T14:25:02.832000Z

Ticket 5 has been modified: escaping smart quotes along with literal backslash inside
Edited By: Günter Milde (milde)
Status updated: u'open' => u'closed'

#4 How to programatically use the commandline parameters?

2017-09-12T20:43:46.293000Z

For an example using publish_string, see
http://docutils.sourceforge.net/docs/api/publisher.html#configuration

#4 How to programatically use the commandline parameters?

2017-09-12T20:13:43.733000Z

It would be helpful to know how it will be the programatically use of the command line

using by docutils.core Publish

rst2s5.py --theme medium-black slides.txt slides.html

and an equivalent code could be

from docutils.core import publish_string

variable_string='\nsome text\n========='
result = publish_string(variable_string, writer_name='rst2s5')

And again how to pass the theme keyyword. That's because the front end (https://github.com/marianoguerra/rst2html5) also uses the publish_cmdline(writer_name='html', description=description)

#4 How to programatically use the commandline parameters?

2017-09-12T18:34:05.796000Z

Those documents refer to the core Docutils code. But you seem to be using a third-party front-end tool. If you need help for that tool, you should ask its author.

Note that core Docutils also has a rst2html5.py front end. It is NOT the same as the one you referenced (https://github.com/marianoguerra/rst2html5). I don't know how that one works or if it is compatible, and we cannot help you with specifics about that tool.