Skip to content

Commit df50bfa

Browse files
committed
Add placeholder for API overview.
1 parent ad9f6e9 commit df50bfa

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

docs/source/in_depth/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Overview
2+
========
3+
4+
TODO:
5+
6+
* add a brief overview of the most important classes (Client, Submission, etc.)
7+
* add a brief overview of the most important functions (create_submission, get_submission, etc.)
8+
* write about the difference between high-level api and low-level api

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Every contribution, big or small, is valuable!
7070
:titlesonly:
7171
:hidden:
7272

73+
in_depth/overview
7374
in_depth/client_resolution
7475

7576

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy