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

Extend SDK layer 1 docs #5011

Merged
merged 17 commits into from
Oct 5, 2022
Merged

Extend SDK layer 1 docs #5011

merged 17 commits into from
Oct 5, 2022

Conversation

zhiltsov-max
Copy link
Contributor

@zhiltsov-max zhiltsov-max commented Sep 28, 2022

Motivation and context

  • Added more documentation on ApiClient usage
  • Added autogeneration of github pages for ApiClient members
  • Refactored GitHub workflows to generate SDK only once

How has this been tested?

mkdir -p cvat-sdk/schema/ && python manage.py spectacular --file cvat-sdk/schema/schema.yml
cd cvat-sdk/
gen/generate.sh

cd ..

git submodule update --init --recursive
site/process_sdk_docs.py
cd site/
hugo server

Checklist

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@zhiltsov-max zhiltsov-max changed the title [WIP] Extend SDK layer 1 docs Extend SDK layer 1 docs Sep 30, 2022
.github/workflows/main.yml Show resolved Hide resolved
cvat-sdk/gen/postprocess.py Show resolved Hide resolved
cvat-sdk/gen/templates/README.md.template Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/developer-guide.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/content/en/docs/api_sdk/sdk/lowlevel-api.md Outdated Show resolved Hide resolved
site/process_sdk_docs.py Outdated Show resolved Hide resolved
site/requirements.txt Show resolved Hide resolved
cvat-sdk/gen/postprocess.py Show resolved Hide resolved
@SpecLad
Copy link
Contributor

SpecLad commented Oct 4, 2022

Frankly, with so much fixing up I wonder if it would be simpler to write a custom documentation generator...

@zhiltsov-max
Copy link
Contributor Author

@nmanovic , this PR is ready for merging.

@nmanovic nmanovic merged commit 426f8e3 into develop Oct 5, 2022
@nmanovic nmanovic deleted the zm/extend-api-docs branch October 5, 2022 11:02
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.

3 participants