Skip to content

Commit 29fc872

Browse files
fixed docs
1 parent 763bdd7 commit 29fc872

File tree

3 files changed

+17
-35
lines changed

3 files changed

+17
-35
lines changed

_doc/class_reference.rst

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,20 @@ Class reference
55
Models
66
======================================
77

8-
ConfigModel
8+
ConfigMixin
99
--------------------------------------
1010

11-
.. inheritance-diagram:: easyconfig.ConfigModel
12-
:top-classes: easyconfig.models.config_model.ConfigModel
13-
:parts: 1
11+
.. autoclass:: easyconfig.ConfigMixin
12+
:members:
1413

15-
.. autoclass:: easyconfig.ConfigModel
16-
:members: on_all_values_set, subscribe_for_changes
17-
:member-order: groupwise
18-
19-
PathModel
14+
AppConfigMixin
2015
--------------------------------------
2116

22-
.. inheritance-diagram:: easyconfig.PathModel
23-
:top-classes: easyconfig.models.config_model.ConfigModel
24-
:parts: 1
25-
26-
.. autoclass:: easyconfig.PathModel
27-
:members: on_all_values_set, subscribe_for_changes, set_file_path
28-
:member-order: groupwise
29-
30-
AppConfigModel
31-
--------------------------------------
32-
33-
.. inheritance-diagram:: easyconfig.AppConfigModel
34-
:top-classes: easyconfig.models.config_model.ConfigModel
35-
:parts: 1
36-
37-
.. autoclass:: easyconfig.AppConfigModel
38-
:members: on_all_values_set, subscribe_for_changes, set_file_path, load_dict, load_file
39-
:member-order: groupwise
40-
17+
.. autoclass:: easyconfig.AppConfigMixin
18+
:members:
4119

4220
Subscription
4321
======================================
4422

45-
.. autoclass:: easyconfig.model_subscription.Subscription
46-
:members: cancel
23+
.. autoclass:: easyconfig.config_objs.ConfigObjSubscription
24+
:members:

_doc/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
# -- Project information -----------------------------------------------------
2222
project = 'easyconfig'
23-
copyright = '2021, spacemanspiff2007'
23+
copyright = '2022, spacemanspiff2007'
2424
author = 'spacemanspiff2007'
2525

2626
# The full version, including alpha/beta/rc tags
@@ -34,7 +34,6 @@
3434
extensions = [
3535
'sphinx.ext.autodoc',
3636
'sphinx_autodoc_typehints',
37-
'sphinx.ext.inheritance_diagram',
3837
]
3938

4039
# Add any paths that contain templates here, relative to this directory.
@@ -57,3 +56,8 @@
5756
# relative to this directory. They are copied after the builtin static files,
5857
# so a file named "default.css" will overwrite the builtin "default.css".
5958
html_static_path = ['_static']
59+
60+
61+
autodoc_default_options = {
62+
'inherited-members': True,
63+
}

_doc/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Packages required to build the documentation
2-
sphinx
3-
sphinx-autodoc-typehints
4-
sphinx_rtd_theme
2+
sphinx >= 4.4, < 5
3+
sphinx-autodoc-typehints >= 1.17, < 2
4+
sphinx_rtd_theme >= 1, < 2

0 commit comments

Comments
 (0)