Skip to content

Commit 0147ef1

Browse files
committed
docs: Add API docs
1 parent 1359ddf commit 0147ef1

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

docs/api.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
API
2+
===
3+
4+
codeforces
5+
----------
6+
7+
api
8+
^^^
9+
10+
.. automodule:: codeforces.api
11+
:members:
12+
13+
error
14+
^^^^^
15+
16+
.. automodule:: codeforces.error
17+
:members:

docs/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@
4040
# ones.
4141
extensions = [
4242
'sphinx.ext.autodoc',
43-
'sphinx.ext.doctest',
4443
'sphinx.ext.coverage',
45-
'sphinx.ext.viewcode',
44+
'sphinx.ext.doctest',
4645
'sphinx.ext.githubpages',
46+
'sphinx.ext.napoleon',
47+
'sphinx.ext.viewcode',
4748
]
4849

4950
# Add any paths that contain templates here, relative to this directory.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Welcome to python-codeforces's documentation!
1111
:caption: Contents:
1212

1313
usage/quickstart
14+
api
1415

1516

1617
Indices and tables

0 commit comments

Comments
 (0)