Skip to content

Commit ed4af17

Browse files
mahenzonmahenzon
committed
upgrade and fix docs
1 parent 0421f93 commit ed4af17

File tree

11 files changed

+109
-167
lines changed

11 files changed

+109
-167
lines changed

‎docs/atomic_operations.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,12 @@ Notes
259259

260260

261261
.. note::
262-
See `examples for SQLAlchemy <SQLA_examples>`_ in the repo, all examples are based on it.
262+
See `examples for SQLAlchemy`_ in the repo, all examples are based on it.
263263

264264

265265
.. note::
266266
Atomic Operations provide ``current_atomic_operation`` context variable.
267-
Usage example can be found in `tests for current_atomic_operation <tests_current_atomic>`_.
267+
Usage example can be found in tests `test_current_atomic_operation`_.
268268

269269

270270
.. warning::
@@ -276,5 +276,5 @@ Notes
276276

277277
Includes in the response body are not supported (and not planned, until you PR it)
278278

279-
.. _SQLA_examples: https://github.com/mts-ai/FastAPI-JSONAPI/tree/main/examples/api_for_sqlalchemy
280-
.. _tests_current_atomic: https://github.com/mts-ai/FastAPI-JSONAPI/blob/main/tests/test_atomic/test_current_atomic_operation.py
279+
.. _`examples for SQLAlchemy`: https://github.com/mts-ai/FastAPI-JSONAPI/tree/main/examples/api_for_sqlalchemy
280+
.. _`test_current_atomic_operation`: https://github.com/mts-ai/FastAPI-JSONAPI/blob/main/tests/test_atomic/test_current_atomic_operation.py

‎docs/conf.py‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
#
7474
# This is also used if you do content translation via gettext catalogs.
7575
# Usually you set "language" from the command line for these cases.
76-
language = None
76+
language = "en"
7777

7878
# There are two options for replacing |today|: either, you set today to some
7979
# non-false value, then it is used:
@@ -133,15 +133,9 @@
133133
# documentation.
134134
#
135135
html_theme_options = {
136-
"github_user": "mts-ai",
137-
"github_repo": "FastAPI-JSONAPI",
138-
"github_banner": True,
139-
"show_related": True,
140-
"page_width": "1080px",
141-
"fixed_sidebar": True,
142-
"code_font_size": "0.8em",
143-
"show_nav_level": 2,
144-
"navigation_depth": 2,
136+
"display_version": True,
137+
"sticky_navigation": True,
138+
"navigation_depth": 4,
145139
}
146140

147141
# Add any paths that contain custom themes here, relative to this directory.
@@ -170,7 +164,7 @@
170164
# Add any paths that contain custom static files (such as style sheets) here,
171165
# relative to this directory. They are copied after the builtin static files,
172166
# so a file named "default.css" will overwrite the builtin "default.css".
173-
html_static_path = ["_static"]
167+
# html_static_path = ["_static"]
174168

175169
# Add any extra paths that contain custom files (such as robots.txt or
176170
# .htaccess) here, relative to this directory. These files are copied

‎docs/fastapi-jsonapi.rst‎

Lines changed: 19 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
fastapi_jsonapi package
2-
==========================
1+
Package fastapi_jsonapi index
2+
=============================
33

44
fastapi_jsonapi.data_layers.fields.enum module
5-
-------------------------------------------------------
5+
----------------------------------------------
66

77
.. automodule:: fastapi_jsonapi.data_layers.fields.enum
88
:members:
99
:undoc-members:
1010
:show-inheritance:
1111

1212
fastapi_jsonapi.data_layers.fields.mixins module
13-
-------------------------------------------------------
13+
------------------------------------------------
1414

1515
.. automodule:: fastapi_jsonapi.data_layers.fields.mixins
1616
:members:
@@ -26,23 +26,23 @@ fastapi_jsonapi.data_layers.filtering.sqlalchemy module
2626
:show-inheritance:
2727

2828
fastapi_jsonapi.data_layers.filtering.tortoise_operation module
29-
-------------------------------------------------------
29+
---------------------------------------------------------------
3030

3131
.. automodule:: fastapi_jsonapi.data_layers.filtering.tortoise_operation
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:
3535

3636
fastapi_jsonapi.data_layers.filtering.tortoise_orm module
37-
-------------------------------------------------------
37+
---------------------------------------------------------
3838

3939
.. automodule:: fastapi_jsonapi.data_layers.filtering.tortoise_orm
4040
:members:
4141
:undoc-members:
4242
:show-inheritance:
4343

4444
fastapi_jsonapi.data_layers.sorting.sqlalchemy module
45-
-------------------------------------------------------
45+
-----------------------------------------------------
4646

4747
.. automodule:: fastapi_jsonapi.data_layers.sorting.sqlalchemy
4848
:members:
@@ -58,135 +58,95 @@ fastapi_jsonapi.data_layers.sorting.tortoise_orm module
5858
:show-inheritance:
5959

6060
fastapi_jsonapi.data_layers.base module
61-
-------------------------------------------------------
61+
---------------------------------------
6262

6363
.. automodule:: fastapi_jsonapi.data_layers.base
6464
:members:
6565
:undoc-members:
6666
:show-inheritance:
6767

6868
fastapi_jsonapi.data_typing module
69-
-------------------------------------------------------
69+
----------------------------------
7070

7171
.. automodule:: fastapi_jsonapi.data_typing
7272
:members:
7373
:undoc-members:
7474
:show-inheritance:
7575

7676
fastapi_jsonapi.data_layers.orm module
77-
-------------------------------------------------------
77+
--------------------------------------
7878

7979
.. automodule:: fastapi_jsonapi.data_layers.orm
8080
:members:
8181
:undoc-members:
8282
:show-inheritance:
8383

8484
fastapi_jsonapi.data_layers.shared module
85-
-------------------------------------------------------
85+
-----------------------------------------
8686

8787
.. automodule:: fastapi_jsonapi.data_layers.shared
8888
:members:
8989
:undoc-members:
9090
:show-inheritance:
9191

9292
fastapi_jsonapi.data_layers.sqla_orm module
93-
-------------------------------------------------------
93+
-------------------------------------------
9494

9595
.. automodule:: fastapi_jsonapi.data_layers.sqla_orm
9696
:members:
9797
:undoc-members:
9898
:show-inheritance:
9999

100100
fastapi_jsonapi.data_layers.tortoise_orm module
101-
-------------------------------------------------------
101+
-----------------------------------------------
102102

103103
.. automodule:: fastapi_jsonapi.data_layers.tortoise_orm
104104
:members:
105105
:undoc-members:
106106
:show-inheritance:
107107

108-
fastapi_jsonapi.exception.base module
109-
-------------------------------------------------------
110-
111-
.. automodule:: fastapi_jsonapi.exception.base
112-
:members:
113-
:undoc-members:
114-
:show-inheritance:
115-
116-
fastapi_jsonapi.exception.json_api module
117-
-------------------------------------------------------
118-
119-
.. automodule:: fastapi_jsonapi.exception.json_api
120-
:members:
121-
:undoc-members:
122-
:show-inheritance:
123-
124-
fastapi_jsonapi.exception.base module
125-
-------------------------------------------------------
126-
127-
.. automodule:: fastapi_jsonapi.exception.base
128-
:members:
129-
:undoc-members:
130-
:show-inheritance:
131-
132108
fastapi_jsonapi.api module
133-
-------------------------------------------------------
109+
--------------------------
134110

135111
.. automodule:: fastapi_jsonapi.api
136112
:members:
137113
:undoc-members:
138114
:show-inheritance:
139115

140116
fastapi_jsonapi.jsonapi_typing module
141-
-------------------------------------------------------
117+
-------------------------------------
142118

143119
.. automodule:: fastapi_jsonapi.jsonapi_typing
144120
:members:
145121
:undoc-members:
146122
:show-inheritance:
147123

148-
fastapi_jsonapi.methods module
149-
-------------------------------------------------------
150-
151-
.. automodule:: fastapi_jsonapi.methods
152-
:members:
153-
:undoc-members:
154-
:show-inheritance:
155-
156-
fastapi_jsonapi.openapi module
157-
-------------------------------------------------------
158-
159-
.. automodule:: fastapi_jsonapi.openapi
160-
:members:
161-
:undoc-members:
162-
:show-inheritance:
163-
164124
fastapi_jsonapi.querystring module
165-
-------------------------------------------------------
125+
----------------------------------
166126

167127
.. automodule:: fastapi_jsonapi.querystring
168128
:members:
169129
:undoc-members:
170130
:show-inheritance:
171131

172132
fastapi_jsonapi.schema module
173-
-------------------------------------------------------
133+
-----------------------------
174134

175135
.. automodule:: fastapi_jsonapi.schema
176136
:members:
177137
:undoc-members:
178138
:show-inheritance:
179139

180140
fastapi_jsonapi.signature module
181-
-------------------------------------------------------
141+
--------------------------------
182142

183143
.. automodule:: fastapi_jsonapi.signature
184144
:members:
185145
:undoc-members:
186146
:show-inheritance:
187147

188148
fastapi_jsonapi.splitter module
189-
-------------------------------------------------------
149+
-------------------------------
190150

191151
.. automodule:: fastapi_jsonapi.splitter
192152
:members:

‎docs/filtering.rst‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ In this example, we want to retrieve people whose name is equal to their birth_d
4444

4545
If you want to filter through relationships you can do that:
4646

47-
.. sourcecode:: http
4847

49-
GET /user?filter=[
48+
49+
.. sourcecode:: json
50+
[
5051
{
5152
"name": "group",
5253
"op": "any",
@@ -56,7 +57,12 @@ If you want to filter through relationships you can do that:
5657
"val": "%admin%"
5758
}
5859
}
59-
] HTTP/1.1
60+
]
61+
62+
63+
.. sourcecode:: http
64+
65+
GET [{"name":"group","op":"any","val":{"name":"name","op":"ilike","val":"%admin%"}}] HTTP/1.1
6066
Accept: application/vnd.api+json
6167

6268
.. note ::
@@ -72,9 +78,9 @@ There is a shortcut to achieve the same filtering:
7278

7379
You can also use boolean combination of operations:
7480

75-
.. sourcecode:: http
81+
.. sourcecode:: json
7682

77-
GET /user?filter=[
83+
[
7884
{
7985
"name":"group.name",
8086
"op":"ilike",
@@ -105,7 +111,11 @@ You can also use boolean combination of operations:
105111
}
106112
]
107113
}
108-
] HTTP/1.1
114+
]
115+
116+
.. sourcecode:: http
117+
118+
GET /user?filter=[{"name":"group.name","op":"ilike","val":"%admin%"},{"or":[{"not":{"name":"first_name","op":"eq","val":"John"}},{"and":[{"name":"first_name","op":"like","val":"%Jim%"},{"name":"date_create","op":"gt","val":"1990-01-01"}]}]}] HTTP/1.1
109119
Accept: application/vnd.api+json
110120

111121
Common available operators:

‎docs/include_many_to_many.rst‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -90,29 +90,10 @@ Base Views
9090

9191
``api/base.py``:
9292

93-
.. literalinclude:: ../examples/api_for_sqlalchemy/api/base.py
93+
.. literalinclude:: ../examples/api_for_sqlalchemy/api/views_base.py
9494
:language: python
9595

9696

97-
Parent Views
98-
^^^^^^^^^^^^
99-
100-
``schemas/child.py``:
101-
102-
.. literalinclude:: ../examples/api_for_sqlalchemy/api/parent.py
103-
:language: python
104-
105-
106-
Child Views
107-
^^^^^^^^^^^
108-
109-
``schemas/child.py``:
110-
111-
.. literalinclude:: ../examples/api_for_sqlalchemy/api/child.py
112-
:language: python
113-
114-
115-
11697
List Parent objects with Children through an Association object
11798
===============================================================
11899

‎docs/index.rst‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,18 @@ FastAPI-JSONAPI with FastAPI.
7474
resource_manager
7575
data_layer
7676
relationships
77+
configuration
78+
79+
.. toctree::
80+
:maxdepth: 2
81+
7782
sparse_fieldsets
7883
pagination
7984
sorting
8085
errors
81-
api
8286
permission
8387
oauth
84-
configuration
88+
fastapi-jsonapi
8589

8690
.. toctree::
8791
:maxdepth: 2

‎docs/minimal_api_example.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _minimal_api_example:
2+
13
.. include:: ./minimal_api_head.rst
24

35
Request:

‎docs/modules.rst‎

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

0 commit comments

Comments
 (0)