Migrate documentation to Read the Docs#18
Open
harryswift01 wants to merge 6 commits into
Open
Conversation
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
This PR migrates the main
prepmddocumentation from the repositoryREADME.mdinto 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:
docs/directory generated using Sphinx..readthedocs.yamlto configure Read the Docs builds.Move README content into documentation pages:
README.md.runmd, developer notes, and future work.Add API documentation support:
prepmdpackage.furotheme and copy-button support.Impact
prepmdwith a standard Read the Docs documentation workflow.