feat(docs): add MkDocs site and GitHub Pages deploy workflow#5
Merged
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.
This pull request adds comprehensive documentation for PyThrust, including quickstart guides, API reference, example workflows, and a full mathematical description of the calibration model. It also introduces a dedicated documentation build and deploy workflow using MkDocs and GitHub Pages, and updates the CI workflow and README to reflect the removal of the PyBaMM dependency and new documentation practices.
Documentation additions and improvements:
docs/api_reference.md), getting started guide (docs/getting_started.md), example walkthroughs (docs/examples.md), and a development/testing guide (docs/development.md). [1] [2] [3] [4]docs/index.md).docs/motor_calibration.md).docs/databases.md).docs/javascripts/mathjax.js).Build and deployment automation:
Deploy Docsworkflow to.github/workflows/docs.ymlthat builds and deploys the MkDocs site to GitHub Pages when documentation files change onmain.docsextra and removed the unusedpybammdependency from the main CI workflow (.github/workflows/ci-cd.yml).Other updates:
These changes provide a robust, user-friendly documentation experience and streamline the build and deployment process for the PyThrust project.
Closes #4