Skip to content

Migrate documentation to Read the Docs#18

Open
harryswift01 wants to merge 6 commits into
mainfrom
17-migrate-documentation-to-read-the-docs
Open

Migrate documentation to Read the Docs#18
harryswift01 wants to merge 6 commits into
mainfrom
17-migrate-documentation-to-read-the-docs

Conversation

@harryswift01

Copy link
Copy Markdown
Member

Summary

This PR migrates the main prepmd documentation from the repository README.md into a structured Sphinx documentation site suitable for Read the Docs.

The README is kept as a shorter project overview, while the detailed installation, usage, API, and developer documentation now live under the new docs/ structure.

Changes

Add Read the Docs/Sphinx documentation structure:

  • Added a docs/ directory generated using Sphinx.
  • Added the main documentation index and separate documentation pages.
  • Added .readthedocs.yaml to configure Read the Docs builds.
  • Added Sphinx build files for local documentation generation.

Move README content into documentation pages:

  • Moved detailed usage information out of README.md.
  • Added structured pages for installation, quickstart, Python API usage, running with runmd, developer notes, and future work.
  • Kept the README focused on a shorter overview of the project.

Add API documentation support:

  • Added Sphinx autodoc/autosummary configuration.
  • Generated initial API documentation pages for the prepmd package.
  • Added optional dependency mocks for autodoc so the documentation can build without requiring all runtime dependencies.
  • Configured the documentation to use the furo theme and copy-button support.

Impact

  • Makes the documentation easier to navigate and maintain.
  • Aligns prepmd with a standard Read the Docs documentation workflow.
  • Provides a clearer split between the README and full user/developer documentation.
  • Enables future versioned documentation through Read the Docs.
  • Documentation builds successfully with Sphinx, although some existing docstrings still produce formatting warnings that can be cleaned up in a follow-up PR.

@harryswift01 harryswift01 requested a review from Rob-Welch June 8, 2026 12:49
@harryswift01 harryswift01 self-assigned this Jun 8, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Jun 8, 2026
@harryswift01 harryswift01 linked an issue Jun 8, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate Documentation to Read the Docs

1 participant