reStructuredText Reviews and Details

Is reStructuredText good?

Social recommendations and mentions

• Show HN: Tritium – The Legal IDE in Rust

  Much (but not all) of what you are looking for exists in the reStructuredText [1] space. Sphinx [2] is an SSG focused on technical writing about software that you may find worth exploring. Also, the scientific text community has been pushing MyST [3] which is an attempt to take some of the best ideas of reStructuredText and reapply them to Markdown-style syntax as a baseline. The MyST tools are a lot more recent... - Source: Hacker News / 4 months ago

• Writing a book in the age of open source

  I can sympathize with the OP authors' frustration with Markdown and resulting preference for ASCIIDoc (try to format a poem, or a play script, in Markdown). Lots of people have addressed this, and NIH rules supreme -- see reStructured Text[2]. However several comments here mention the convenience of a workflow based on Markdown + GIT. Exactly that workflow is the heart of Leanpub[0]. That site facilitates writing... - Source: Hacker News / about 1 year ago

• How To Choose the Best Static Site Generator and Deploy it to Kinsta for Free

  Markup language: Markup language is used to write documents in a way that distinguishes them from plain text. Most SSGs utilize lightweight markup languages, such as Markdown. However, alternatives like AsciiDoc, Textile, and ReStructuredText are also used. These lightweight languages simplify content creation and are converted into HTML during the site generation process. - Source: dev.to / almost 2 years ago

• Packaging Python projects in 2023 from scratch

  Uses Sphinx, reStructuredText And the sphinx-rtd-theme for writing, building And rendering the documentation. Source: about 2 years ago

• What's the #1 feature that is needed in Obsidian, if one feature is all you get

  If we're dreaming, ReStructed Text support. Source: over 2 years ago

• Why Is Markdown Popular?

  You can always switch to rst¹ and sphinx² to produce html/pdf came join the dark side, we have tables³ :) 1. https://docutils.sourceforge.io/rst.html. - Source: Hacker News / almost 3 years ago

• Math on GitHub: Following Up

  ReStrutucturedText is still useful to look at for inspiration here. It had the concepts of extensible metadata ("field lists"), spans ("interpreted text"), and blocks ("directives"). Including things like applying metadata to spans (using essentially Footnotes to provide field lists to interpreted text sections, like but better than Markdown's reference style for hyperlinks which almost no one uses but were much... - Source: Hacker News / over 3 years ago

• Announcing Minimal OpenD6, an SRD for Mini Six

  Minimal OpenD6 provides ReStructuredText source For the document, as well as simple PDF, HTML, EPUB, Microsoft Word .docx, and OpenOffice/LibreOffice .odt output. Conversions to Other formats are possible using pandoc or Other means. Source: over 3 years ago

• Best python programming practices - Every Python Developer Must Know

  - reStructuredText lets you create in-line documentation.Most Python documentation is written with reStructuredText. It’s like Markdown, but with all the optional extensions built in. - Source: dev.to / about 4 years ago

• What soft does OpenShot use for User Guide

  Our User Guide is written in RST and converted to HTML by Sphinx. Source: over 4 years ago

• Are there any conventions for documenting / commenting on your code?

  Thanks, while looking into docstyle I found this and this and these things are largely what I was interested in. As for the over-commenting, I should probably cut that out. Source: over 4 years ago