Rst Tools Direct

While Sphinx is great for hierarchical documentation, static site generators (SSGs) use RST to build blogs and simple websites.

  • Nikola:

    • In a world dominated by Markdown, conversion tools are essential for interoperability.

  • rst2md:

    • Pitfall 1: “My bullet list broke because of inconsistent indentation.”
    Solution: Run doc8 --max-line-length 89 to catch indentation errors. rst tools

    Pitfall 2: “I renamed a heading and now my links are broken.”
    Solution: Sphinx’s nitpicky = True mode will warn you about every unresolved reference.

    Pitfall 3: “My table is too wide for PDF output.”
    Solution: Use .. list-table:: with :widths: or the rst2pdf custom stylesheet. While Sphinx is great for hierarchical documentation, static

    The standard for syntax checking. rstcheck is a command-line tool that checks RST files for syntax errors and structural issues. It integrates with docutils and can validate:

    Usage:

    rstcheck my_document.rst

    Pro tip: Integrate rstcheck into your pre-commit Git hooks to block commits with broken RST.