Skip to content

Commit e9a3da7

Browse files
BrainIsDeadBrainIsDead
committed
The changes made in this commit include:
- Added `base.migrations.rst` file. - Added `base.rst` file. - Added `base.tests.rst` file. - Added `conf.py` file. - Added `datasources.migrations.rst` file. - Added `datasources.rst` file. - Added `datasources.tests.rst` file. - Added `index.rst` file. - Added `modules.rst` file. - Added `signal_documentation.rst` file. - Added `signals.migrations.rst` file. - Added `signals.rst` file. - Added `signals.tests.rst` file.
1 parent 8ac4acb commit e9a3da7

13 files changed

+459
-2
lines changed

‎src/docs/source/base.migrations.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
base.migrations package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
base.migrations.0001\_initial module
8+
------------------------------------
9+
10+
.. automodule:: base.migrations.0001_initial
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
base.migrations.0002\_link\_created\_link\_modified module
16+
----------------------------------------------------------
17+
18+
.. automodule:: base.migrations.0002_link_created_link_modified
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: base.migrations
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎src/docs/source/base.rst

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
base package
2+
============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
base.migrations
11+
base.tests
12+
13+
Submodules
14+
----------
15+
16+
base.admin module
17+
-----------------
18+
19+
.. automodule:: base.admin
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
base.apps module
25+
----------------
26+
27+
.. automodule:: base.apps
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
base.models module
33+
------------------
34+
35+
.. automodule:: base.models
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
base.views module
41+
-----------------
42+
43+
.. automodule:: base.views
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: base
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎src/docs/source/base.tests.rst

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

‎src/docs/source/conf.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,25 @@
55

66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
import os
9+
import sys
810

911
project = 'Signal Documentation'
1012
copyright = '2023, cmu.edu'
1113
author = 'cmu.edu'
1214
release = '1.0.0'
1315

16+
sys.path.insert(0, os.path.abspath("../.."))
17+
18+
django_settings = "signal_documentation.settings"
19+
1420
# -- General configuration ---------------------------------------------------
1521
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1622

17-
extensions = []
23+
extensions = [
24+
"sphinxcontrib_django",
25+
'sphinx.ext.autodoc',
26+
]
1827

1928
templates_path = ['_templates']
2029
exclude_patterns = []
@@ -23,5 +32,6 @@
2332
# -- Options for HTML output -------------------------------------------------
2433
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
2534

35+
# html_theme = "sphinx_rtd_theme"
2636
html_theme = 'alabaster'
2737
html_static_path = ['_static']

‎src/docs/source/datasources.migrations.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
datasources.migrations package
2+
==============================
3+
4+
Submodules
5+
----------
6+
7+
datasources.migrations.0001\_initial module
8+
-------------------------------------------
9+
10+
.. automodule:: datasources.migrations.0001_initial
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
datasources.migrations.0002\_alter\_sourcesubdivision\_db\_source module
16+
------------------------------------------------------------------------
17+
18+
.. automodule:: datasources.migrations.0002_alter_sourcesubdivision_db_source
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
datasources.migrations.0003\_datasource\_created\_datasource\_modified\_and\_more module
24+
----------------------------------------------------------------------------------------
25+
26+
.. automodule:: datasources.migrations.0003_datasource_created_datasource_modified_and_more
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: datasources.migrations
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎src/docs/source/datasources.rst

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
datasources package
2+
===================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
datasources.migrations
11+
datasources.tests
12+
13+
Submodules
14+
----------
15+
16+
datasources.admin module
17+
------------------------
18+
19+
.. automodule:: datasources.admin
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
datasources.apps module
25+
-----------------------
26+
27+
.. automodule:: datasources.apps
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
datasources.models module
33+
-------------------------
34+
35+
.. automodule:: datasources.models
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
datasources.resources module
41+
----------------------------
42+
43+
.. automodule:: datasources.resources
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
datasources.views module
49+
------------------------
50+
51+
.. automodule:: datasources.views
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:
55+
56+
Module contents
57+
---------------
58+
59+
.. automodule:: datasources
60+
:members:
61+
:undoc-members:
62+
:show-inheritance:

‎src/docs/source/datasources.tests.rst

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

‎src/docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Welcome to Signal Documentation's documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13-
13+
modules
1414

1515
Indices and tables
1616
==================

‎src/docs/source/modules.rst

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

‎src/docs/source/signal_documentation.rst

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

0 commit comments

Comments
 (0)