Skip to content

Adds support for mkdocs #100

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

Merged
merged 2 commits into from
May 24, 2025
Merged

Adds support for mkdocs #100

merged 2 commits into from
May 24, 2025

Conversation

sebastian-quintero
Copy link
Member

@sebastian-quintero sebastian-quintero commented May 24, 2025

Description

Adds a new way of documenting the Python SDKs with:

  • Heavily edits the docstrings of the entire project across all Python files.
  • Adds the new docs dir with all the source of the docs in .md.
  • Copies over all the docs we had from the docs site to here, in the form of "Tutorials".
  • Introduces the technical "Reference" with the documentation of the Python modules, classes, functions, methods, etc.

To serve the documentation locally:

  • Install the requirements.
$ pip install docs/requirements.txt
  • Serve.
$ mkdocs build && mkdocs serve

@sebastian-quintero sebastian-quintero merged commit 8c8dea7 into develop May 24, 2025
46 of 47 checks passed
@sebastian-quintero sebastian-quintero deleted the feature/mkdocs branch May 24, 2025 07:31
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