From: Stefan M. <sm...@oe...> - 2013-11-13 21:39:41
|
Hi Benoît! Yesterday Benoît Bryon wrote: > Le 04/11/2013 09:07, Christian Weiske a écrit : >> Our use-case would be unifying headline markup, so that all our rST >> documents have the same first level headline style, same second level >> headline style etc. > > This use case also was the initial motivation for rst2rst. Well, *this* can be done in Emacs in rst-mode. Try `rst-straighten-sections` (C-c C-a C-s). There are some more settings for formatting things but there is no such thing like "reformat this file". > So I'd like to have some "rstlint" beautifier. And rst2rst would be a > part of such a tool: > > rstlint = "reStructuredText style guide" + rst2rst Then first of all we need a number of settings which determine the format - like the overline / underline thing. `xml2rst` supports the overline / underline thing but many other things are (more or less) hard-coded. > About the conventions, I once started > http://documentation-style-guide-sphinx.readthedocs.org/en/latest/, Exactly something like that. > Le 25/10/2013 21:37, Peter Funk a écrit : >> Would you or David care to explain, why it seems to be so damn hard to >> implement something like this? > > Current rst2rst implementation is naive. It tries to build output within > a single pass, while walking through the tree (i.e. directly within > visit_* and depart_* methods). > But sometimes we cannot render a node directly, we need information > about the parent context, or about children nodes... I agree that rendering reStructuredText is quite hard. > A better implementation would be to re-build a tree, where nodes carry > information about reStructuredText attributes (indentation, line length, > heading level...). > Then it would be easy to first render leaf nodes (usually text) and then > render parents. Though this is true I don't think this is the best solution. AFAIR the `xml2rst` code checks the context for such information. > So I also feel that, perhaps, it would be easier if docutils > parser itself assigns attributes to nodes while building the tree. Well. I don't think that the parser or the XML language should create / contain information just for rendering reStructuredText. *But* some more (optional) information about the exact format of the source would be nice... > I mean, perhaps docutils parser could assign indentation, bullet > character, heading with overline flag, heading character... to nodes > while parsing the input. ...like this. Grüße Stefan |