Skip to content

Commit 860d1bf

Browse files
ichrys03ichrys03
committed
update on docs
1 parent 78a272e commit 860d1bf

9 files changed

Lines changed: 241 additions & 35 deletions

File tree

‎docs/api.rst‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,50 @@
11
API Documentation
22
=================
33

4+
epyt.epanet
5+
-----------
6+
47
.. automodule:: epyt.epanet
58
:members:
69
:undoc-members:
7-
:show-inheritance:
10+
:show-inheritance:
11+
12+
epyt.src.epanetapi
13+
------------------
14+
15+
.. automodule:: epyt.src.epanetapi
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
epyt.src.epanetconstants
21+
------------------------
22+
23+
.. automodule:: epyt.src.epanetconstants
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
epyt.src.epanetmsxapi
29+
---------------------
30+
31+
.. automodule:: epyt.src.epanetmsxapi
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
epyt.src.epyt_enums
37+
-------------------
38+
39+
.. automodule:: epyt.src.epyt_enums
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
epyt.src.epanet_cffi_compat
45+
---------------------------
46+
47+
.. automodule:: epyt.src.epanet_cffi_compat
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:

‎docs/conf.py‎

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,25 @@
11
# -- Path setup --------------------------------------------------------------
22

3-
# If extensions (or modules to document with autodoc) are in another directory,
4-
# add these directories to sys.path here. If the directory is relative to the
5-
# documentation root, use os.path.abspath to make it absolute, like shown here.
6-
#
7-
# import os
8-
# import sys
9-
# sys.path.insert(0, os.path.abspath('.'))
3+
import sys
4+
import os
5+
6+
# Project root (so 'epyt' is importable as a package)
7+
sys.path.insert(0, os.path.abspath('..'))
108

9+
# epyt/src/ so modules inside src are discoverable by autodoc
10+
sys.path.insert(0, os.path.abspath('../epyt/src'))
1111

1212
# -- Project information -----------------------------------------------------
1313

1414
project = 'epyt'
1515
copyright = '2022, KIOS Research and Innovation Center of Excellence'
16-
# If extensions (or modules to document with autodoc) are in another directory,
17-
# add these directories to sys.path here.
18-
import sys
19-
import os
20-
sys.path.insert(0, os.path.abspath('..'))
21-
2216
author = 'KIOS CoE'
2317

2418
# The full version, including alpha/beta/rc tags
2519
release = '1.0.7'
2620

2721
# -- General configuration ---------------------------------------------------
2822

29-
# Add any Sphinx extension module names here, as strings. They can be
30-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31-
# ones.
3223
extensions = [
3324
'sphinx.ext.duration',
3425
'sphinx.ext.doctest',
@@ -39,26 +30,25 @@
3930
'sphinx_copybutton'
4031
]
4132

42-
# Add any paths that contain templates here, relative to this directory.
33+
# Mock C extensions that cannot be imported during doc builds
34+
autodoc_mock_imports = ['cffi']
35+
36+
# Autodoc settings - automatically document all members
37+
autodoc_default_options = {
38+
'members': True,
39+
'undoc-members': True,
40+
'show-inheritance': True,
41+
'member-order': 'bysource',
42+
'special-members': '__init__',
43+
}
44+
45+
autosummary_generate = True
46+
4347
templates_path = ['_templates']
4448

45-
# List of patterns, relative to source directory, that match files and
46-
# directories to ignore when looking for source files.
47-
# This pattern also affects html_static_path and html_extra_path.
48-
exclude_patterns = []
49+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
4950

5051
# -- Options for HTML output -------------------------------------------------
5152

52-
# The theme to use for HTML and HTML Help pages. See the documentation for
53-
# a list of builtin themes.
54-
#
55-
# Add any paths that contain custom static files (such as style sheets) here,
56-
# relative to this directory. They are copied after the builtin static files,
57-
# so a file named "default.css" will overwrite the builtin "default.css".
58-
html_static_path = ['_static']
59-
6053
html_theme = 'sphinx_rtd_theme'
61-
62-
# extensions = ['sphinx.ext.autosummary',]
63-
# autodoc_default_flags = ['members']
64-
# autosummary_generate = True
54+
html_static_path = ['_static']

‎docs/epyt.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
epyt package
2+
============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
epyt.src
11+
12+
Submodules
13+
----------
14+
15+
epyt.epanet module
16+
------------------
17+
18+
.. automodule:: epyt.epanet
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: epyt
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:

‎docs/epyt.src.rst‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
epyt.src package
2+
================
3+
4+
Submodules
5+
----------
6+
7+
8+
epyt.src.epanetapi module
9+
-------------------------
10+
11+
.. automodule:: epyt.src.epanetapi
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
16+
epyt.src.epanetconstants module
17+
-------------------------------
18+
19+
.. automodule:: epyt.src.epanetconstants
20+
:members:
21+
:show-inheritance:
22+
:undoc-members:
23+
24+
epyt.src.epanetmsxapi module
25+
----------------------------
26+
27+
.. automodule:: epyt.src.epanetmsxapi
28+
:members:
29+
:show-inheritance:
30+
:undoc-members:
31+
32+
epyt.src.epyt\_enums module
33+
---------------------------
34+
35+
.. automodule:: epyt.src.epyt_enums
36+
:members:
37+
:show-inheritance:
38+
:undoc-members:
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: epyt.src
44+
:members:
45+
:show-inheritance:
46+
:undoc-members:

‎docs/epyt_src/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
src
2+
===
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
src

‎docs/epyt_src/src.rst‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
src package
2+
===========
3+
4+
Submodules
5+
----------
6+
7+
8+
src.epanetapi module
9+
--------------------
10+
11+
.. automodule:: src.epanetapi
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
16+
src.epanetconstants module
17+
--------------------------
18+
19+
.. automodule:: src.epanetconstants
20+
:members:
21+
:show-inheritance:
22+
:undoc-members:
23+
24+
src.epanetmsxapi module
25+
-----------------------
26+
27+
.. automodule:: src.epanetmsxapi
28+
:members:
29+
:show-inheritance:
30+
:undoc-members:
31+
32+
src.epyt\_enums module
33+
----------------------
34+
35+
.. automodule:: src.epyt_enums
36+
:members:
37+
:show-inheritance:
38+
:undoc-members:
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: src
44+
:members:
45+
:show-inheritance:
46+
:undoc-members:

‎docs/modules.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ EPyT
55
:maxdepth: 4
66

77
epyt
8-
setup

‎docs/src.rst‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
src package
2+
===========
3+
4+
Submodules
5+
----------
6+
7+
8+
src.epanetapi module
9+
--------------------
10+
11+
.. automodule:: src.epanetapi
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
16+
src.epanetconstants module
17+
--------------------------
18+
19+
.. automodule:: src.epanetconstants
20+
:members:
21+
:show-inheritance:
22+
:undoc-members:
23+
24+
src.epanetmsxapi module
25+
-----------------------
26+
27+
.. automodule:: src.epanetmsxapi
28+
:members:
29+
:show-inheritance:
30+
:undoc-members:
31+
32+
src.epyt\_enums module
33+
----------------------
34+
35+
.. automodule:: src.epyt_enums
36+
:members:
37+
:show-inheritance:
38+
:undoc-members:
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: src
44+
:members:
45+
:show-inheritance:
46+
:undoc-members:

‎epyt/src/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)