Skip to content

Commit 6fdd798

Browse files
vsochvsoch
committed
adding missing api docs
Signed-off-by: Vanessa Sochat <[email protected]>
1 parent a0bcc03 commit 6fdd798

File tree

94 files changed

+27758
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+27758
-1
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Singularity Compose
22

33
This is a simple orchestration library for Singularity containers, akin to
4-
Docker Compose. See the [specification]() and the [documentation]() for
4+
Docker Compose. See the [specification](https://singularityhub.github.io/singularity-compose/#/spec/spec-1.0)
5+
and the [documentation](https://singularityhub.github.io/singularity-compose) for
56
details, or more examples below.
67

78
## Examples

‎docs/api/_sources/changelog.md.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CHANGELOG
2+
3+
This is a manually generated log to track changes to the repository for each release.
4+
Each section should include general headers such as **Implemented enhancements**
5+
and **Merged pull requests**. Critical items to know are:
6+
7+
- renamed commands
8+
- deprecated / removed commands
9+
- changed defaults
10+
- backward incompatible changes
11+
- migration guidance
12+
- changed behaviour
13+
14+
The versions coincide with releases on pypi.
15+
16+
## [0.0.x](https://github.com/singularityhub/singularity-compose/tree/master) (0.0.x)
17+
- alpha release with simple (single container) working example (0.0.1)
18+
- dummy release (0.0.0)

‎docs/api/_sources/index.rst.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Welcome to Singularity Compose API's documentation!
2+
===================================================
3+
4+
Singularity Compose is an orchestration tool for Singularity instances.
5+
6+
Contents:
7+
8+
.. toctree::
9+
:maxdepth: 3
10+
11+
source/scompose.rst
12+
changelog.md
13+
14+
15+
Indices and tables
16+
------------------
17+
18+
* :ref:`modindex`

‎docs/api/_sources/source/modules.rst.txt‎

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

‎docs/api/_sources/source/scompose.client.rst.txt‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
scompose.client package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
scompose.client.build module
8+
----------------------------
9+
10+
.. automodule:: scompose.client.build
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
scompose.client.config module
16+
-----------------------------
17+
18+
.. automodule:: scompose.client.config
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
scompose.client.create module
24+
-----------------------------
25+
26+
.. automodule:: scompose.client.create
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
scompose.client.down module
32+
---------------------------
33+
34+
.. automodule:: scompose.client.down
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
scompose.client.exec module
40+
---------------------------
41+
42+
.. automodule:: scompose.client.exec
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
scompose.client.logs module
48+
---------------------------
49+
50+
.. automodule:: scompose.client.logs
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
scompose.client.ps module
56+
-------------------------
57+
58+
.. automodule:: scompose.client.ps
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
scompose.client.restart module
64+
------------------------------
65+
66+
.. automodule:: scompose.client.restart
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
scompose.client.shell module
72+
----------------------------
73+
74+
.. automodule:: scompose.client.shell
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
scompose.client.up module
80+
-------------------------
81+
82+
.. automodule:: scompose.client.up
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
88+
Module contents
89+
---------------
90+
91+
.. automodule:: scompose.client
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:

‎docs/api/_sources/source/scompose.logger.rst.txt‎

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

‎docs/api/_sources/source/scompose.project.rst.txt‎

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

‎docs/api/_sources/source/scompose.rst.txt‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
scompose package
2+
================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
9+
scompose.client
10+
scompose.logger
11+
scompose.project
12+
scompose.templates
13+
scompose.tests
14+
scompose.utils
15+
16+
Submodules
17+
----------
18+
19+
scompose.version module
20+
-----------------------
21+
22+
.. automodule:: scompose.version
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
27+
28+
Module contents
29+
---------------
30+
31+
.. automodule:: scompose
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/api/_sources/source/scompose.templates.rst.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
scompose.templates package
2+
==========================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: scompose.templates
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

‎docs/api/_sources/source/scompose.tests.rst.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
scompose.tests package
2+
======================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
9+
scompose.tests.testdata
10+
11+
Submodules
12+
----------
13+
14+
scompose.tests.test\_client module
15+
----------------------------------
16+
17+
.. automodule:: scompose.tests.test_client
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
scompose.tests.test\_utils module
23+
---------------------------------
24+
25+
.. automodule:: scompose.tests.test_utils
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: scompose.tests
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

0 commit comments

Comments
 (0)