Skip to content

Commit 0d065c8

Browse files
Improve config and context reference pages (#598)
1 parent 5826dcc commit 0d065c8

File tree

5 files changed

+557
-384
lines changed

5 files changed

+557
-384
lines changed

docs/book.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,8 @@ img.logo {
4747
height: 1em;
4848
opacity: 50%;
4949
}
50+
51+
/* less ugly autodoc references */
52+
dd .field-odd {
53+
margin: 0;
54+
}

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,7 @@
5353
# relative to this directory. They are copied after the builtin static files,
5454
# so a file named "default.css" will overwrite the builtin "default.css".
5555
html_static_path = ['_static']
56+
57+
# NOTE: Nice dataclasses
58+
autodoc_typehints = 'description'
59+
autodoc_typehints_format = 'short'

docs/config-reference.rst

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
1-
.. automodule:: dipdup.config
2-
:members:
1+
.. autoclass:: dipdup.config.DipDupConfig
2+
.. autoclass:: dipdup.config.AdvancedConfig
3+
.. autoclass:: dipdup.config.BigMapHandlerConfig
4+
.. autoclass:: dipdup.config.BigMapIndexConfig
5+
.. autoclass:: dipdup.config.CoinbaseDatasourceConfig
6+
.. autoclass:: dipdup.config.ContractConfig
7+
.. autoclass:: dipdup.config.EventHandlerConfig
8+
.. autoclass:: dipdup.config.EventIndexConfig
9+
.. autoclass:: dipdup.config.HasuraConfig
10+
.. autoclass:: dipdup.config.HeadHandlerConfig
11+
.. autoclass:: dipdup.config.HeadIndexConfig
12+
.. autoclass:: dipdup.config.HookConfig
13+
.. autoclass:: dipdup.config.HTTPConfig
14+
.. autoclass:: dipdup.config.HttpDatasourceConfig
15+
.. autoclass:: dipdup.config.IndexTemplateConfig
16+
.. autoclass:: dipdup.config.IpfsDatasourceConfig
17+
.. autoclass:: dipdup.config.JobConfig
18+
.. autoclass:: dipdup.enums.LoggingValues
19+
:members:
20+
:undoc-members:
21+
.. autoclass:: dipdup.config.MetadataDatasourceConfig
22+
.. autoclass:: dipdup.config.OperationHandlerConfig
23+
.. autoclass:: dipdup.config.OperationHandlerOriginationPatternConfig
24+
.. autoclass:: dipdup.config.OperationHandlerTransactionPatternConfig
25+
.. autoclass:: dipdup.config.OperationIndexConfig
26+
.. autoclass:: dipdup.enums.OperationType
27+
:members:
28+
:undoc-members:
29+
.. autoclass:: dipdup.config.OperationUnfilteredHandlerConfig
30+
.. autoclass:: dipdup.config.OperationUnfilteredIndexConfig
31+
.. autoclass:: dipdup.config.PostgresDatabaseConfig
32+
.. autoclass:: dipdup.config.PrometheusConfig
33+
.. autoclass:: dipdup.enums.ReindexingAction
34+
:members:
35+
:undoc-members:
36+
.. autoclass:: dipdup.enums.ReindexingReason
37+
:members:
38+
:undoc-members:
39+
.. autoclass:: dipdup.config.SentryConfig
40+
.. autoclass:: dipdup.enums.SkipHistory
41+
:members:
42+
:undoc-members:
43+
.. autoclass:: dipdup.config.SqliteDatabaseConfig
44+
.. autoclass:: dipdup.config.TokenTransferHandlerConfig
45+
.. autoclass:: dipdup.config.TokenTransferIndexConfig
46+
.. autoclass:: dipdup.config.TzktDatasourceConfig
47+
.. autoclass:: dipdup.config.UnknownEventHandlerConfig

0 commit comments

Comments
 (0)