Skip to content

Use mkdocs for documentation #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

smokestacklightnin
Copy link
Member

@smokestacklightnin smokestacklightnin commented May 7, 2025

This PR sets up documentation using mkdocs and includes a workflow to deploy the docs to GitHub Pages.

Once this PR is merged someone with the appropriate privileges will need to enable publishing docs from the gh-pages branch

A preview of the documentation can be found here

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@smokestacklightnin smokestacklightnin marked this pull request as draft May 7, 2025 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant