Skip to content

Commit 1b5898f

Browse files
committed
Initial setup of doc structure.
1 parent 22d4ae6 commit 1b5898f

File tree

11 files changed

+145
-69
lines changed

11 files changed

+145
-69
lines changed

docs/source/api/api.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
API Module
2+
==========
3+
4+
.. automodule:: judge0.api
5+
:members:
6+
:undoc-members:

docs/source/api/clients.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Clients Module
2+
==============
3+
4+
.. automodule:: judge0.clients
5+
:members:
6+
:member-order: groupwise

docs/source/api/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. toctree::
2+
:maxdepth: 2
3+
4+
api
5+
submission
6+
clients

docs/source/api/submission.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Submission Module
2+
=================
3+
4+
.. automodule:: judge0.submission
5+
:members:
6+
:member-order: groupwise

docs/source/api_index.rst

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@
2929
exclude_patterns = []
3030

3131

32+
# add_module_names = False
33+
3234
# -- Options for HTML output -------------------------------------------------
3335
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3436

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. toctree::
2+
:maxdepth: 2
3+
4+
contributing
5+
release_notes
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
How to create a release candidate
2+
=================================
3+
4+
TODO

docs/source/index.rst

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,54 @@
1+
===============================
12
Judge0 Python SDK documentation
23
===============================
34

5+
Getting Started
6+
===============
7+
8+
You can run minimal Hello World example in three easy steps:
9+
10+
1. Install Judge0 Python SDK:
11+
12+
.. code-block:: bash
13+
14+
pip install judge0
15+
16+
2. Create a minimal script:
17+
18+
.. code-block:: Python
19+
20+
import judge0
21+
22+
submission = judge.run(source_code="print('Hello Judge0!')")
23+
print(submission.stdout)
24+
25+
3. Run the script.
26+
27+
Want to learn more
28+
------------------
29+
30+
31+
To learn what is happening behind the scenes and how to best use Judge0 Python
32+
SDK to facilitate the development of your own product see In Depth guide and
33+
Examples.
34+
35+
Getting Involved
36+
----------------
37+
38+
TODO
39+
40+
.. toctree::
41+
:caption: Getting Involved
42+
:glob:
43+
:titlesonly:
44+
:hidden:
45+
46+
contributors_guide/index
47+
448
.. toctree::
5-
:maxdepth: 2
6-
:caption: Contents
49+
:caption: API
50+
:glob:
51+
:titlesonly:
52+
:hidden:
753

8-
api_index
9-
contributing
54+
api/index

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