Skip to content

Commit 44d8c2c

Browse files
chadhatchadhat
committed
adding sphinx docs
1 parent 39384cf commit 44d8c2c

9 files changed

Lines changed: 331 additions & 0 deletions

File tree

‎docs/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 = ../../sphinxdoc-docs
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)

‎docs/conf.py‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('../'))
16+
sys.path.insert(0, os.path.abspath('../SwissKnife'))
17+
18+
19+
# -- Project information -----------------------------------------------------
20+
21+
project = 'SIPEC'
22+
copyright = '2021, Dr Markus Marks'
23+
author = 'Dr Markus Marks'
24+
25+
26+
# -- General configuration ---------------------------------------------------
27+
28+
# Add any Sphinx extension module names here, as strings. They can be
29+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30+
# ones.
31+
extensions = [
32+
]
33+
34+
35+
extensions += ['sphinxarg.ext']
36+
37+
extensions += [
38+
'sphinx.ext.napoleon','sphinx.ext.autodoc'
39+
]
40+
41+
42+
43+
napoleon_google_docstring = False
44+
napoleon_use_param = False
45+
napoleon_use_ivar = True
46+
47+
source_suffix = {
48+
'.rst': 'restructuredtext',
49+
'.txt': 'restructuredtext',
50+
'.md': 'markdown',
51+
}
52+
53+
54+
# Add any paths that contain templates here, relative to this directory.
55+
templates_path = ['_templates']
56+
57+
# List of patterns, relative to source directory, that match files and
58+
# directories to ignore when looking for source files.
59+
# This pattern also affects html_static_path and html_extra_path.
60+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
61+
62+
63+
# -- Options for HTML output -------------------------------------------------
64+
65+
# The theme to use for HTML and HTML Help pages. See the documentation for
66+
# a list of builtin themes.
67+
#
68+
html_theme = 'alabaster'
69+
70+
# Add any paths that contain custom static files (such as style sheets) here,
71+
# relative to this directory. They are copied after the builtin static files,
72+
# so a file named "default.css" will overwrite the builtin "default.css".
73+
html_static_path = ['_static']

‎docs/index.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. SIPEC documentation master file, created by
2+
sphinx-quickstart on Fri Jun 4 12:02:09 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to SIPEC's documentation!
7+
=================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
source/SwissKnife
14+
15+
16+
Indices and tables
17+
==================
18+
19+
* :ref:`genindex`
20+
* :ref:`modindex`
21+
* :ref:`search`

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/SwissKnife.rst‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
SwissKnife package
2+
==================
3+
4+
Submodules
5+
----------
6+
7+
SwissKnife.architectures module
8+
-------------------------------
9+
10+
.. automodule:: SwissKnife.architectures
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
SwissKnife.augmentations module
16+
-------------------------------
17+
18+
.. automodule:: SwissKnife.augmentations
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
SwissKnife.behavior module
24+
--------------------------
25+
26+
.. automodule:: SwissKnife.behavior
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
SwissKnife.classification\_comparison module
32+
--------------------------------------------
33+
34+
.. automodule:: SwissKnife.classification_comparison
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
SwissKnife.dataloader module
40+
----------------------------
41+
42+
.. automodule:: SwissKnife.dataloader
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
SwissKnife.dataprep module
48+
--------------------------
49+
50+
.. automodule:: SwissKnife.dataprep
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
SwissKnife.extract\_videos module
56+
---------------------------------
57+
58+
.. automodule:: SwissKnife.extract_videos
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
SwissKnife.full\_inference module
64+
---------------------------------
65+
66+
.. automodule:: SwissKnife.full_inference
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
SwissKnife.identification module
72+
--------------------------------
73+
74+
.. automodule:: SwissKnife.identification
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
SwissKnife.job\_runner module
80+
-----------------------------
81+
82+
.. automodule:: SwissKnife.job_runner
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
SwissKnife.masksmoothing module
88+
-------------------------------
89+
90+
.. automodule:: SwissKnife.masksmoothing
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
SwissKnife.model module
96+
-----------------------
97+
98+
.. automodule:: SwissKnife.model
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
SwissKnife.poseestimation module
104+
--------------------------------
105+
106+
.. automodule:: SwissKnife.poseestimation
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
110+
111+
SwissKnife.segmentation module
112+
------------------------------
113+
114+
.. automodule:: SwissKnife.segmentation
115+
:members:
116+
:undoc-members:
117+
:show-inheritance:
118+
119+
SwissKnife.test module
120+
----------------------
121+
122+
.. automodule:: SwissKnife.test
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
127+
SwissKnife.unsupervised module
128+
------------------------------
129+
130+
.. automodule:: SwissKnife.unsupervised
131+
:members:
132+
:undoc-members:
133+
:show-inheritance:
134+
135+
SwissKnife.utils module
136+
-----------------------
137+
138+
.. automodule:: SwissKnife.utils
139+
:members:
140+
:undoc-members:
141+
:show-inheritance:
142+
143+
SwissKnife.visualization module
144+
-------------------------------
145+
146+
.. automodule:: SwissKnife.visualization
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
150+
151+
Module contents
152+
---------------
153+
154+
.. automodule:: SwissKnife
155+
:members:
156+
:undoc-members:
157+
:show-inheritance:

‎docs/source/get-pip.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
get\-pip module
2+
===============
3+
4+
.. automodule:: get-pip
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/modules.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
SIPEC
2+
=====
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
SwissKnife
8+
get-pip
9+
test

‎docs/source/test.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
test module
2+
===========
3+
4+
.. automodule:: test
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/test.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import keras
2+
print(keras.__version__)

0 commit comments

Comments
 (0)