Skip to content

Convert docs from Sphinx to MkDocs #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Convert docs from Sphinx to MkDocs #333

wants to merge 1 commit into from

Conversation

giohappy
Copy link
Contributor

Summary

  • convert all .rst docs to Markdown
  • move docs into docs/
  • provide mkdocs.yml configuration
  • add helper script convert_rst_to_md.py

Testing

  • mkdocs build

https://chatgpt.com/codex/tasks/task_b_685564f5ed2c832fb86b1314533b97c7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
codex
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@giohappy