Skip to content
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

Setup Mkdocs Material using Github Pages #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Ritik3111
Copy link
Contributor

@Ritik3111 Ritik3111 commented May 10, 2023

Solves #9

  • Create a new MkDocs project in the root directory of our codebase (docs).

  • Configure MkDocs to generate documentation from the Python function docstrings.

  • Add any additional documentation pages that are required.

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.

None yet

1 participant