Skip to content

Commit 6b68ef6

Browse files
committed
make base docs
1 parent af7cdaa commit 6b68ef6

16 files changed

Lines changed: 458 additions & 0 deletions

docs/.nojekyll

Whitespace-only changes.

docs/requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sphinx
2+
sphinx-autoapi
3+
jsoncrack-for-sphinx
4+
furo
5+
enum-tools
6+
sphinx_toolbox

docs/source/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
pyaterochka\_api.endpoints.advertising
2+
======================================
3+
4+
.. automodule:: pyaterochka_api.endpoints.advertising
5+
6+
7+
.. rubric:: Classes
8+
9+
.. autosummary::
10+
11+
ClassAdvertising
12+
FetchResponse
13+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
pyaterochka\_api.endpoints.catalog
2+
==================================
3+
4+
.. automodule:: pyaterochka_api.endpoints.catalog
5+
6+
7+
.. rubric:: Classes
8+
9+
.. autosummary::
10+
11+
ClassCatalog
12+
FetchResponse
13+
ProductService
14+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
pyaterochka\_api.endpoints.general
2+
==================================
3+
4+
.. automodule:: pyaterochka_api.endpoints.general
5+
6+
7+
.. rubric:: Classes
8+
9+
.. autosummary::
10+
11+
BytesIO
12+
ClassGeneral
13+
ExponentialRetry
14+
RetryClient
15+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
pyaterochka\_api.endpoints.geolocation
2+
======================================
3+
4+
.. automodule:: pyaterochka_api.endpoints.geolocation
5+
6+
7+
.. rubric:: Classes
8+
9+
.. autosummary::
10+
11+
ClassGeolocation
12+
FetchResponse
13+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
pyaterochka\_api.endpoints
2+
==========================
3+
4+
.. automodule:: pyaterochka_api.endpoints
5+
6+
7+
.. rubric:: Modules
8+
9+
.. autosummary::
10+
:toctree:
11+
:recursive:
12+
13+
advertising
14+
catalog
15+
general
16+
geolocation
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
pyaterochka\_api.manager
2+
========================
3+
4+
.. automodule:: pyaterochka_api.manager
5+
6+
7+
.. rubric:: Functions
8+
9+
.. autosummary::
10+
11+
dataclass
12+
field
13+
14+
.. rubric:: Classes
15+
16+
.. autosummary::
17+
18+
Any
19+
AsyncCamoufox
20+
ClassAdvertising
21+
ClassCatalog
22+
ClassGeneral
23+
ClassGeolocation
24+
FetchResponse
25+
HeaderAnomalySniffer
26+
HumanBrowser
27+
HumanContext
28+
HumanPage
29+
Proxy
30+
PyaterochkaAPI
31+
WaitHeader
32+
defaultdict
33+

docs/source/_static/logo-day.png

136 KB
Loading

0 commit comments

Comments
 (0)