Skip to content

Commit 059e488

Browse files
woojiahaowoojiahao
committed
Add all git_autograder file docs
1 parent 53c25c6 commit 059e488

File tree

8 files changed

+316
-14
lines changed

8 files changed

+316
-14
lines changed

‎docs/source/conf.py‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,18 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
project = "git-mastery"
9+
project = "git-autograder"
1010
copyright = "2025, Jiahao Woo"
1111
author = "Jiahao Woo"
1212
release = "5.3.1"
1313

1414
# -- General configuration ---------------------------------------------------
1515
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1616

17-
extensions = []
17+
extensions = [
18+
"sphinx.ext.autodoc",
19+
"sphinx.ext.viewcode"
20+
]
1821

1922
templates_path = ["_templates"]
2023
exclude_patterns = []

‎docs/source/git_autograder.answers.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
git\_autograder.answers package
2+
===============================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
git_autograder.answers.rules
11+
12+
Submodules
13+
----------
14+
15+
git\_autograder.answers.answers module
16+
--------------------------------------
17+
18+
.. automodule:: git_autograder.answers.answers
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
git\_autograder.answers.answers\_parser module
24+
----------------------------------------------
25+
26+
.. automodule:: git_autograder.answers.answers_parser
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
git\_autograder.answers.answers\_record module
32+
----------------------------------------------
33+
34+
.. automodule:: git_autograder.answers.answers_record
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: git_autograder.answers
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:

‎docs/source/git_autograder.answers.rules.rst‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
git\_autograder.answers.rules package
2+
=====================================
3+
4+
Submodules
5+
----------
6+
7+
git\_autograder.answers.rules.answer\_rule module
8+
-------------------------------------------------
9+
10+
.. automodule:: git_autograder.answers.rules.answer_rule
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
git\_autograder.answers.rules.contains\_list\_rule module
16+
---------------------------------------------------------
17+
18+
.. automodule:: git_autograder.answers.rules.contains_list_rule
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
git\_autograder.answers.rules.contains\_value\_rule module
24+
----------------------------------------------------------
25+
26+
.. automodule:: git_autograder.answers.rules.contains_value_rule
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
git\_autograder.answers.rules.has\_exact\_list\_rule module
32+
-----------------------------------------------------------
33+
34+
.. automodule:: git_autograder.answers.rules.has_exact_list_rule
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
git\_autograder.answers.rules.has\_exact\_value\_rule module
40+
------------------------------------------------------------
41+
42+
.. automodule:: git_autograder.answers.rules.has_exact_value_rule
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:
46+
47+
git\_autograder.answers.rules.not\_empty\_rule module
48+
-----------------------------------------------------
49+
50+
.. automodule:: git_autograder.answers.rules.not_empty_rule
51+
:members:
52+
:show-inheritance:
53+
:undoc-members:
54+
55+
Module contents
56+
---------------
57+
58+
.. automodule:: git_autograder.answers.rules
59+
:members:
60+
:show-inheritance:
61+
:undoc-members:

‎docs/source/git_autograder.diff.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
git\_autograder.diff package
2+
============================
3+
4+
Submodules
5+
----------
6+
7+
git\_autograder.diff.diff module
8+
--------------------------------
9+
10+
.. automodule:: git_autograder.diff.diff
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
git\_autograder.diff.diff\_helper module
16+
----------------------------------------
17+
18+
.. automodule:: git_autograder.diff.diff_helper
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: git_autograder.diff
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:

‎docs/source/git_autograder.helpers.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
git\_autograder.helpers package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
git\_autograder.helpers.branch\_helper module
8+
---------------------------------------------
9+
10+
.. automodule:: git_autograder.helpers.branch_helper
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
git\_autograder.helpers.commit\_helper module
16+
---------------------------------------------
17+
18+
.. automodule:: git_autograder.helpers.commit_helper
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
git\_autograder.helpers.file\_helper module
24+
-------------------------------------------
25+
26+
.. automodule:: git_autograder.helpers.file_helper
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
git\_autograder.helpers.remote\_helper module
32+
---------------------------------------------
33+
34+
.. automodule:: git_autograder.helpers.remote_helper
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: git_autograder.helpers
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:

‎docs/source/git_autograder.rst‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
git\_autograder package
2+
=======================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
git_autograder.answers
11+
git_autograder.diff
12+
git_autograder.helpers
13+
14+
Submodules
15+
----------
16+
17+
git\_autograder.branch module
18+
-----------------------------
19+
20+
.. automodule:: git_autograder.branch
21+
:members:
22+
:show-inheritance:
23+
:undoc-members:
24+
25+
git\_autograder.commit module
26+
-----------------------------
27+
28+
.. automodule:: git_autograder.commit
29+
:members:
30+
:show-inheritance:
31+
:undoc-members:
32+
33+
git\_autograder.encoder module
34+
------------------------------
35+
36+
.. automodule:: git_autograder.encoder
37+
:members:
38+
:show-inheritance:
39+
:undoc-members:
40+
41+
git\_autograder.exception module
42+
--------------------------------
43+
44+
.. automodule:: git_autograder.exception
45+
:members:
46+
:show-inheritance:
47+
:undoc-members:
48+
49+
git\_autograder.exercise module
50+
-------------------------------
51+
52+
.. automodule:: git_autograder.exercise
53+
:members:
54+
:show-inheritance:
55+
:undoc-members:
56+
57+
git\_autograder.exercise\_config module
58+
---------------------------------------
59+
60+
.. automodule:: git_autograder.exercise_config
61+
:members:
62+
:show-inheritance:
63+
:undoc-members:
64+
65+
git\_autograder.output module
66+
-----------------------------
67+
68+
.. automodule:: git_autograder.output
69+
:members:
70+
:show-inheritance:
71+
:undoc-members:
72+
73+
git\_autograder.reflog\_entry module
74+
------------------------------------
75+
76+
.. automodule:: git_autograder.reflog_entry
77+
:members:
78+
:show-inheritance:
79+
:undoc-members:
80+
81+
git\_autograder.remote module
82+
-----------------------------
83+
84+
.. automodule:: git_autograder.remote
85+
:members:
86+
:show-inheritance:
87+
:undoc-members:
88+
89+
git\_autograder.repo module
90+
---------------------------
91+
92+
.. automodule:: git_autograder.repo
93+
:members:
94+
:show-inheritance:
95+
:undoc-members:
96+
97+
git\_autograder.status module
98+
-----------------------------
99+
100+
.. automodule:: git_autograder.status
101+
:members:
102+
:show-inheritance:
103+
:undoc-members:
104+
105+
git\_autograder.test\_utils module
106+
----------------------------------
107+
108+
.. automodule:: git_autograder.test_utils
109+
:members:
110+
:show-inheritance:
111+
:undoc-members:
112+
113+
Module contents
114+
---------------
115+
116+
.. automodule:: git_autograder
117+
:members:
118+
:show-inheritance:
119+
:undoc-members:

‎docs/source/index.rst‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
1-
.. git-mastery documentation master file, created by
2-
sphinx-quickstart on Wed Jul 30 07:03:09 2025.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
6-
git-mastery documentation
7-
=========================
8-
9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
12-
1+
git-autograder documentation
2+
============================
133

144
.. toctree::
155
:maxdepth: 2
166
:caption: Contents:
7+
:glob:
8+
9+
git_autograder*
1710

‎docs/source/modules.rst‎

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

0 commit comments

Comments
 (0)