WIP: Output to RST

[Vertmo]

I've started working on an output to ReStructuredText, a format mainly used for documentation.

Usage

• ott [...] -o file.rst
• secondary mode : split the output into multiple files (one per rule / production) with the option -rst_split_output true

TODO

• Document the mode
• Handle cases for other Struct in output-splitting mode
• Test with more complete specs

[PeterSewell]

"reStructuredText (RST, ReST, or reST) is a file format for textual data used primarily in the Python programming language community for technical documentation" [wikipedia] I doubt we want to complicate the Ott code with support for this - is there really a broad motivation?

…

On 05/06/2019, Basile Pesin ***@***.***> wrote: I've started working on an output to ReStructuredText, a format mainly used for documentation. ### Usage * `ott [...] -o file.rst` * secondary mode : split the output into multiple files (one per rule / production) with the option `-rst_split_output true` ### TODO [ ] Document the mode [ ] Handle cases for other `Struct` in output-splitting mode [ ] Test with more complete specs You can view, comment on, or merge this pull request online at: #50 -- Commit Summary -- * Creating an empty rst file * Displaying relations OK for non-merge source * Support for -merge true * Displaying grammar rules * Added sort to take the grammar rules to the top * Changed the indent for grammar rules * First version of split output * Some aesthetic changes -- File Changes -- M src/auxl.ml (3) M src/defns.ml (41) M src/defns.mli (1) M src/embed_pp.ml (5) M src/grammar_pp.ml (64) M src/main.ml (25) M src/system_pp.ml (117) M src/system_pp.mli (3) M src/types.ml (6) -- Patch Links -- https://github.com/ott-lang/ott/pull/50.patch https://github.com/ott-lang/ott/pull/50.diff -- You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub: #50

[Vertmo]

Well, to be honest I was working on this mainly to serve my specific purpose. However, it's interesting to note that rst is used in the ReadTheDocs tool, which powers (among other things) the documentation of dune (https://dune.readthedocs.io/en/latest/) and Coq itself (https://coq.inria.fr/distrib/current/refman/) so I'd say it's still relevant for users of ott.