Skip to content

Convert documentation from RST to Markdown#657

Merged
laughingman7743 merged 4 commits intomasterfrom
feature/convert-docs-to-markdown
Feb 8, 2026
Merged

Convert documentation from RST to Markdown#657
laughingman7743 merged 4 commits intomasterfrom
feature/convert-docs-to-markdown

Conversation

@laughingman7743
Copy link
Member

@laughingman7743 laughingman7743 commented Feb 8, 2026

Summary

  • Convert 13 root documentation files under docs/ from RST to MyST Markdown (.md) format
  • Keep 12 API reference files as .rst since autodoc generates RST internally
  • Improve index page with Quick Start section and dropdown TOC navigation using sphinx-design

Closes #652

Details

Markdown conversion (13 root docs)

Files converted: index, api, testing, introduction, cursor, spark, arrow, polars, s3fs, pandas, usage, null_handling, sqlalchemy

Conversion patterns applied:

  • RST labels (.. _label:) → MyST labels ((label)=)
  • RST directives (.. code::, .. note::, .. toctree::) → MyST directives (```{directive})
  • RST grid tables and list-table → standard Markdown tables
  • RST cross-references (:ref:) → MyST {ref} syntax
  • RST hyperlink references → inline Markdown links
  • RST definition lists → MyST definition list syntax (via deflist extension)

API docs kept as RST (12 files)

autodoc generates RST output internally (.. py:class::, .. py:function::, etc.). Using MyST's {autoclass} syntax caused these directives to render as raw text. Rather than wrapping every directive in {eval-rst} blocks, the API reference files are kept as .rst. Sphinx handles .rst/.md coexistence via the source_suffix configuration.

Index page improvements

  • Added Quick Start section with install command and example code
  • Added sphinx-design for dropdown directive support
  • Organized toctree into categorized dropdown sections: Getting Started, Cursors, Integrations, Advanced Topics, API Reference
  • Sidebar now shows grouped navigation with section headings

Configuration changes

  • pyproject.toml: Added myst-parser and sphinx-design to dev dependencies
  • docs/conf.py: Added MyST-Parser extension with colon_fence, fieldlist, deflist extensions; added sphinx_design extension

Test plan

  • sphinx-build -b html docs docs/_build/html builds successfully
  • All pages render correctly (root docs as Markdown, API docs as RST)
  • API documentation renders properly with class/function signatures
  • Cross-references between files resolve properly
  • Code blocks are syntax-highlighted
  • Tables render properly
  • Toctree navigation and dropdown TOC work
  • Sidebar shows grouped navigation
  • make chk passes (lint, format, type checks)

🤖 Generated with Claude Code

Replace all 25 .rst files under docs/ with MyST Markdown equivalents,
add myst-parser as a dev dependency, and configure Sphinx to support
both .rst and .md source files for backward compatibility with older
tagged branches. Closes #652.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@laughingman7743 laughingman7743 marked this pull request as ready for review February 8, 2026 09:02
@laughingman7743 laughingman7743 marked this pull request as draft February 8, 2026 09:07
laughingman7743 and others added 3 commits February 8, 2026 18:12
autodoc generates RST output internally, and when used within MyST
Markdown files via the {autoclass}/{automodule}/{autofunction} syntax,
the generated RST directives (py:module, py:class, py:function) were
rendered as raw text. Wrapping autodoc directives in {eval-rst} blocks
ensures the RST output is properly processed by the RST parser.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The 12 API reference files under docs/api/ rely entirely on autodoc
directives, which generate RST output. Keeping these as .rst files
is simpler than wrapping every directive in {eval-rst} blocks within
Markdown files. Sphinx handles .rst and .md coexistence via the
source_suffix configuration.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add sphinx-design dependency for dropdown directive support
- Add Quick Start section with install command and example code
- Organize toctree into categorized dropdown sections: Getting Started,
  Cursors, Integrations, Advanced Topics, API Reference
- Sidebar now shows grouped navigation with section headings

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@laughingman7743 laughingman7743 force-pushed the feature/convert-docs-to-markdown branch from 29fcb48 to 67b4127 Compare February 8, 2026 09:56
@laughingman7743 laughingman7743 marked this pull request as ready for review February 8, 2026 09:58
@laughingman7743 laughingman7743 merged commit 09d6fa9 into master Feb 8, 2026
5 checks passed
@laughingman7743 laughingman7743 deleted the feature/convert-docs-to-markdown branch February 8, 2026 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Convert documentation from reStructuredText to Markdown

1 participant