Skip to content

Commit 3079cb0

Browse files
drpaulnilssondrpaulnilsson
committed
Added missing doc files
1 parent fbf118b commit 3079cb0

6 files changed

Lines changed: 561 additions & 0 deletions

File tree

‎DIRECTORY_STRUCTURE.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Directory Structure
2+
3+
This document outlines the directory structure of the project.
4+
5+
- **`.github/`**: Contains GitHub Actions workflow files for Continuous Integration and Continuous Deployment (CI/CD).
6+
- **`doc/`**: Contains documentation files for the project, likely using Sphinx.
7+
- **`pilot/`**: The main source code directory for the project.
8+
- **`api/`**: Contains files related to the project's API.
9+
- **`common/`**: Contains common utility functions and classes used across the project.
10+
- **`control/`**: Houses the control logic of the application.
11+
- **`copytool/`**: Includes various tools and modules for file copying operations.
12+
- **`eventservice/`**: Contains files and modules related to the event service.
13+
- **`info/`**: Manages information services and data handling.
14+
- **`resource/`**: Contains modules for resource management.
15+
- **`scripts/`**: Includes various scripts for different tasks.
16+
- **`test/`**: Contains test files for the project.
17+
- **`user/`**: Contains user-specific configurations and files.
18+
- **`util/`**: A directory for various utility functions and modules.
19+
- **`workflow/`**: Manages workflows and related tasks.
20+
- **`LICENSE`**: The license file for the project.
21+
- **`README.md`**: The main README file for the project.
22+
- **`requirements.txt`**: A list of Python packages required to run the project.
23+
- **`setup.py`**: The setup script for the project.

‎doc/api/user/darkside.rst‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
pilot.user.darkside
2+
===================
3+
4+
common
5+
------
6+
7+
.. automodule:: pilot.user.darkside.common
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
container
13+
---------
14+
15+
.. automodule:: pilot.user.darkside.container
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
copytool_definitions
21+
--------------------
22+
23+
.. automodule:: pilot.user.darkside.copytool_definitions
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
cpu
29+
---
30+
31+
.. automodule:: pilot.user.darkside.cpu
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
diagnose
37+
--------
38+
39+
.. automodule:: pilot.user.darkside.diagnose
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
jobdata
45+
-------
46+
47+
.. automodule:: pilot.user.darkside.jobdata
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
jobmetrics
53+
----------
54+
55+
.. automodule:: pilot.user.darkside.jobmetrics
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
loopingjob_definitions
61+
----------------------
62+
63+
.. automodule:: pilot.user.darkside.loopingjob_definitions
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
memory
69+
------
70+
71+
.. automodule:: pilot.user.darkside.memory
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
monitoring
77+
----------
78+
79+
.. automodule:: pilot.user.darkside.monitoring
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
proxy
85+
-----
86+
87+
.. automodule:: pilot.user.darkside.proxy
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
setup
93+
-----
94+
95+
.. automodule:: pilot.user.darkside.setup
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
utilities
101+
---------
102+
103+
.. automodule:: pilot.user.darkside.utilities
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:

‎doc/api/user/generic.rst‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
pilot.user.generic
2+
==================
3+
4+
common
5+
------
6+
7+
.. automodule:: pilot.user.generic.common
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
container
13+
---------
14+
15+
.. automodule:: pilot.user.generic.container
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
copytool_definitions
21+
--------------------
22+
23+
.. automodule:: pilot.user.generic.copytool_definitions
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
cpu
29+
---
30+
31+
.. automodule:: pilot.user.generic.cpu
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
diagnose
37+
--------
38+
39+
.. automodule:: pilot.user.generic.diagnose
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
jobdata
45+
-------
46+
47+
.. automodule:: pilot.user.generic.jobdata
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
jobmetrics
53+
----------
54+
55+
.. automodule:: pilot.user.generic.jobmetrics
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
loopingjob_definitions
61+
----------------------
62+
63+
.. automodule:: pilot.user.generic.loopingjob_definitions
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
memory
69+
------
70+
71+
.. automodule:: pilot.user.generic.memory
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
monitoring
77+
----------
78+
79+
.. automodule:: pilot.user.generic.monitoring
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
proxy
85+
-----
86+
87+
.. automodule:: pilot.user.generic.proxy
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
setup
93+
-----
94+
95+
.. automodule:: pilot.user.generic.setup
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
utilities
101+
---------
102+
103+
.. automodule:: pilot.user.generic.utilities
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:

‎doc/api/user/rubin.rst‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
pilot.user.rubin
2+
================
3+
4+
common
5+
------
6+
7+
.. automodule:: pilot.user.rubin.common
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
container
13+
---------
14+
15+
.. automodule:: pilot.user.rubin.container
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
copytool_definitions
21+
--------------------
22+
23+
.. automodule:: pilot.user.rubin.copytool_definitions
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
cpu
29+
---
30+
31+
.. automodule:: pilot.user.rubin.cpu
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
diagnose
37+
--------
38+
39+
.. automodule:: pilot.user.rubin.diagnose
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
esprocessfinegrainedproc
45+
------------------------
46+
47+
.. automodule:: pilot.user.rubin.esprocessfinegrainedproc
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
jobdata
53+
-------
54+
55+
.. automodule:: pilot.user.rubin.jobdata
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
jobmetrics
61+
----------
62+
63+
.. automodule:: pilot.user.rubin.jobmetrics
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
loopingjob_definitions
69+
----------------------
70+
71+
.. automodule:: pilot.user.rubin.loopingjob_definitions
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
memory
77+
------
78+
79+
.. automodule:: pilot.user.rubin.memory
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
monitoring
85+
----------
86+
87+
.. automodule:: pilot.user.rubin.monitoring
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
proxy
93+
-----
94+
95+
.. automodule:: pilot.user.rubin.proxy
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
setup
101+
-----
102+
103+
.. automodule:: pilot.user.rubin.setup
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:
107+
108+
utilities
109+
---------
110+
111+
.. automodule:: pilot.user.rubin.utilities
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:

0 commit comments

Comments
 (0)