Skip to content

CodeDox v0.2.8 - reStructuredText Support

Choose a tag to compare

@chriswritescode-dev chriswritescode-dev released this 06 Sep 16:28
· 66 commits to master since this release

πŸŽ‰ reStructuredText (RST) Support

CodeDox v0.2.8 introduces comprehensive support for reStructuredText documents, expanding beyond Markdown to support another popular documentation format.

✨ New Features

  • Complete RST Document Processing: Upload and process RST files with intelligent code extraction
  • RST Code Directive Support:
    • .. code-block:: python with language specification and options
    • .. code:: javascript for shorter syntax
    • .. sourcecode:: ruby for alternative directive format
  • Literal Block Extraction: Support for :: syntax with preserved indentation
  • Automatic Language Detection: Smart detection from RST directives
  • Keyboard Shortcuts: Added Escape key support for modal dialogs in Web UI

πŸ”§ Improvements

  • Enhanced Code Extraction Pipeline: Now handles RST documents alongside existing Markdown support
  • Better Statistics Display: Updated dashboard to show both crawl and upload jobs
  • UI Enhancements: Fixed TypeScript type issues and improved modal interactions

πŸ§ͺ Technical Details

  • RST Code Extraction: New RSTCodeExtractor class handles all RST parsing
  • File Format Support: RST files (.rst, .rest, .restx, .rtxt, .rstx) fully supported
  • Comprehensive Testing: Added extensive test suite for RST extraction
  • Context Preservation: Maintains surrounding context for better code understanding

πŸ“ Supported RST File Extensions

.rst, .rest, .restx, .rtxt, .rstx

Perfect for Python projects using Sphinx documentation, technical writing, and any project using reStructuredText format!