Convert documentation from RST to Markdown#657
Merged
laughingman7743 merged 4 commits intomasterfrom Feb 8, 2026
Merged
Conversation
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>
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>
29fcb48 to
67b4127
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/from RST to MyST Markdown (.md) format.rstsince autodoc generates RST internallyCloses #652
Details
Markdown conversion (13 root docs)
Files converted:
index,api,testing,introduction,cursor,spark,arrow,polars,s3fs,pandas,usage,null_handling,sqlalchemyConversion patterns applied:
.. _label:) → MyST labels ((label)=).. code::,.. note::,.. toctree::) → MyST directives (```{directive})list-table→ standard Markdown tables:ref:) → MyST{ref}syntaxdeflistextension)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/.mdcoexistence via thesource_suffixconfiguration.Index page improvements
sphinx-designfor dropdown directive supportConfiguration changes
pyproject.toml: Addedmyst-parserandsphinx-designto dev dependenciesdocs/conf.py: Added MyST-Parser extension withcolon_fence,fieldlist,deflistextensions; addedsphinx_designextensionTest plan
sphinx-build -b html docs docs/_build/htmlbuilds successfullymake chkpasses (lint, format, type checks)🤖 Generated with Claude Code