Add initial MkDocs documentation site#134
Open
eliantiudic wants to merge 4 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 adds an initial MkDocs documentation site for AToM-OpenMM using Material for MkDocs.
It includes:
mkdocs.ymlwith site navigation, theme settings, logo/favicon, search, code copy, and MathJax supportdocs/environment.ymlmastersite/added to.gitignoreHow to Contribute to the Docs
Create the docs environment:
Activate it:
Preview the site locally:
Build and check the docs before pushing:
Most content lives under
docs/. Navigation is controlled inmkdocs.yml.Deployment
The docs workflow runs
mkdocs build --stricton pull requests.After this PR is merged into master, GitHub Actions will build the site and deploy the generated site/ artifact to GitHub Pages.
For deployment to work, GitHub Pages must be enabled in the upstream repository settings:
Settings → Pages → Build and deployment → Source: GitHub Actions