Natural Docs VS reStructuredText

• Readable Comments
  Natural Docs is designed to create natural language documentation from comments, making it easy for developers to write and maintain them.
• Automatic Linking
  It automatically links documentation elements, like functions and classes, helping users navigate the documentation effortlessly.
• Wide Language Support
  Natural Docs supports a wide range of programming languages, making it versatile for different projects.
• Ease of Use
  The tool is relatively easy to set up and use, even for developers who are new to documentation generation.
• Customization Options
  There are options for customizing the output, allowing developers to tailor the documentation to suit their project's style and needs.

Possible disadvantages

• Limited Output Formats
  Natural Docs mainly generates HTML documentation, which might not be suitable for all use cases or integrated documentation setups.
• Markdown Support
  As of the latest information, it lacks extensive support for Markdown, which is a commonly used format for writing documentation.
• Initial Learning Curve
  While easy to use, there is an initial learning curve to understand how to properly write comments to generate the desired documentation.
• Active Maintenance
  The frequency of updates and active maintenance might not be as robust as other more popular documentation tools, potentially leading to slower adoption of new features.
• Specificity
  While versatile, it might not cater to highly specific documentation needs out of the box without significant customization or workarounds.

• Readability
  reStructuredText offers a clean, readable syntax that resembles plain text, making it easy for humans to read and write without requiring special software.
• Extensibility
  It permits extensions and custom directives, allowing users to create new functionalities and adaptations specific to their needs.
• Integration
  It is the default markup language for Python documentation and is naturally supported by Sphinx, which makes it suitable for generating detailed and attractive documentation.
• Semantic Richness
  reStructuredText supports comprehensive semantic markup structures, enabling detailed annotations and proper structuring of documents.

Possible disadvantages

• Complexity
  Learning all of the features of reStructuredText can be complex for beginners due to its wide range of functionalities and strict syntax rules.
• Limited Adoption
  Compared to Markdown, reStructuredText has a smaller user base and community support, which can limit resources and examples available for new users.
• Tool Support
  While it is well-supported in Python environments, outside this ecosystem, there are fewer tools and editors that provide full support and previews for reStructuredText.
• Less Forgiving
  The syntax is more rigid and less forgiving of errors compared to some alternatives like Markdown, which means small mistakes can lead to rendering issues.

Tracking Natural Docs since Mar 2021.

• Shrimple – A Simpler, Nicer Markdown

  .. _reStructuredText: https://docutils.sourceforge.io/rst.html. - Source: Hacker News / 3 months ago

• 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... - Source: Hacker News / over 1 year 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... - Source: Hacker News / about 2 years ago

View more