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

@uniqueg uniqueg requested a review from kellrott February 11, 2023 12:40
@uniqueg uniqueg linked an issue Feb 11, 2023 that may be closed by this pull request
@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
lbeckman314 added a commit that referenced this pull request Nov 1, 2024
* feat: support Python 3.7+; drop Python 2.7,<3.7

* feat: pass through json serialization options

* docs: add advanced usage examples

* feat: spec-compliant routes, with legacy support

* fix: remove debug messages

* test: increase unit test coverage (#52)

* test: increase unit test coverage

* Update tests.yml

---------

Co-authored-by: Liam Beckman <[email protected]>

* docs: browsable API reference on GitHub Pages (#49)

* docs: browsable API reference on GitHub Pages

* Update tests.yml

---------

Co-authored-by: Liam Beckman <[email protected]>

* Minor release testing updates

* Update support for Service Info (#55)

- Fix version to match PyPi release (#59)

* Add integration test with Funnel

* Add initial TES integration test (Funnel)

* Add Tmate debug session

* Update Funnel installation

* Re-add all unit tests

* Fix Funnel download issue with correct rc version

* Add latest stable Python to test matrix

* Fix unit tests not reaching Funnel

* Increase test coverage

* Minor linting fix

* Update raised exception for invalid server response

* Update README

* Update README.md

* Exclude tests from packages (#58)

* Add in 3 fields missing in the models for tes.

---------

Co-authored-by: Alex Kanitz <[email protected]>
Co-authored-by: Kyle Ellrott <[email protected]>
Co-authored-by: Ben Beasley <[email protected]>
Co-authored-by: Venkat Malladi <[email protected]>
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