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

docs: browsable API reference on GitHub Pages #49

Merged
merged 4 commits into from
Jan 9, 2024
Merged

Conversation

uniqueg
Copy link
Collaborator

@uniqueg uniqueg commented Feb 11, 2023

  • Add docstrings to all public modules, classes, methods and functions
  • Build markdown documents of all module, class, method and function docstrings with lazydocs
  • Move detailed docs with notes and recipes to /docs directory, together with API reference
  • Build and publish contents of /docs directory with MkDocs on GitHub Pages
  • Add CI workflow to automatically build and publish docs when code changes are pushed on branch master

Resolves #9

NOTE: PR is ready to review, but not ready to be merged. First, GitHub Pages have to be enabled for this repository.
Afterwards, there may be some minor changes required to initalize the docs deployment.

Screenshots

Screenshots are from local build:

Docs landing page

image

API reference overview

image

tes.client
image

tes.models

image

tes.utils

image

@lbeckman314 lbeckman314 merged commit a0683d8 into release-1.0.0 Jan 9, 2024
1 of 6 checks passed
@lbeckman314 lbeckman314 deleted the api-docs branch February 16, 2024 03:30
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.

Needs introductory documentation and API reference.
2 participants