Add MkDocs documentation site with mkdocstrings #7
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
Add MkDocs configuration and documentation files for generating a documentation site and deploying it through GitHub Pages. * **MkDocs Configuration** - Add `mkdocs.yml` with site name "pybmc Documentation", site URL, material theme, navigation, and plugins configuration. * **Documentation Files** - Add `docs/index.md` with introduction, installation instructions, and usage example. - Add `docs/usage.md` with usage example and explanation of each step. - Add `docs/api_reference.md` with class and method documentation for `Model`, `Dataset`, and `BayesianModelCombination` classes. * **GitHub Actions Workflow** - Add `.github/workflows/gh-pages.yml` for deploying the documentation site to GitHub Pages, including steps for setting up Python, installing dependencies, building the MkDocs site, and deploying to GitHub Pages. * **.gitignore** - Update `.gitignore` to include the `site/` directory generated by MkDocs.
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.
Add MkDocs configuration and documentation files for generating a documentation site and deploying it through GitHub Pages.
MkDocs Configuration
mkdocs.ymlwith site name "pybmc Documentation", site URL, material theme, navigation, and plugins configuration.Documentation Files
docs/index.mdwith introduction, installation instructions, and usage example.docs/usage.mdwith usage example and explanation of each step.docs/api_reference.mdwith class and method documentation forModel,Dataset, andBayesianModelCombinationclasses.GitHub Actions Workflow
.github/workflows/gh-pages.ymlfor deploying the documentation site to GitHub Pages, including steps for setting up Python, installing dependencies, building the MkDocs site, and deploying to GitHub Pages..gitignore
.gitignoreto include thesite/directory generated by MkDocs.