-
Notifications
You must be signed in to change notification settings - Fork 107
Closed
Description
Summary
Convert all .rst files under docs/ to Markdown (.md) format using MyST-Parser, following the README conversion done in #650.
Motivation
- README was already converted from RST to Markdown in Add project logo to README and documentation #650
- Markdown is more widely familiar and easier to maintain
- Consistent format across the project (README + docs)
Scope
25 .rst files to convert:
Root docs/ (13 files)
index.rstintroduction.rstusage.rstcursor.rstpandas.rstarrow.rstpolars.rsts3fs.rstspark.rstsqlalchemy.rstnull_handling.rsttesting.rstapi.rst
docs/api/ (12 files)
connection.rst,converters.rst,errors.rst,models.rst,utilities.rstpandas.rst,arrow.rst,polars.rst,s3fs.rst,spark.rstfilesystem.rst,sqlalchemy.rst
Approach
- Add MyST-Parser as a Sphinx extension to support Markdown in Sphinx
- Convert each
.rstfile to.mdpreserving all content and cross-references - Update
docs/conf.pyextensions and any toctree references - Verify documentation builds correctly with
make docs
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels