docs: add general API overview - #48
Open
ijelacicbot wants to merge 1 commit into
Open
Conversation
Replace the overview placeholder with high-level versus low-level API docs, core types, and the run / async_run flow. Closes judge0#29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/source/in_depth/overview.rstwith a General API Overview.run/async_runflow.Motivation
Closes #29
The In Depth overview page was added as a stub (
Add placeholder for API overview.) and never written. The placeholder asked for:Client,Submission, …)create_submission,get_submission,run, …)Changes
run/execute/async_run/wait/get_client, plus thejudge0.apibatch helpers.Clientmethods that map to Judge0 HTTP routes.async_runis not anasynciocoroutine.Test Plan
uv run sphinx-build -b html docs/source ... -Wsucceedsmaster(not on PRs)Notes for Reviewers
create_submissions/get_submissionsare documented asjudge0.api.*because they are not re-exported fromjudge0.__all__.