Any documentation?

[GaTechThomas]

This seems to be a useful set of tools. Does it have any documentation describing how to use each API?

[dalemyers]

Not at this point. It more or less follows the existing API documentation though: https://docs.microsoft.com/en-us/rest/api/azure/devops/?view=azure-devops-rest-6.1

So, for example, if you wanted to download an artifact from a build, the documentation for that is here: https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/get%20artifact?view=azure-devops-rest-6.1

You can see that the API path is _apis/build/builds/{buildId}/artifacts. If you have a look at the builds module in here (https://github.com/microsoft/simple_ado/blob/main/simple_ado/builds.py) you can see that there is a corresponding download_artifact call.

Note: This is not intended to be a direct replacement for the existing Azure SDK. That can be found here: https://github.com/microsoft/azure-devops-python-api That SDK is fully documented. This is intended to just be a light replacement that is simpler to use.

[imWildCat]

Is it worth generating docs using sphinx, given that the code of this project has detailed docstring?

[dalemyers]

Almost definitely! All PRs are encouraged 😉

[imWildCat]

I can take a look on doc generation.

Let's leverage GitHub pages?