Merge pull request #201 from PalNilsson/next

3.13.0.23

Author: PalNilsson

.github/workflows/build-docs.yml

@@ -1,33 +1,38 @@
 name: build-docs-workflow
 on:
     push:
-       branches:
+        branches:
             - master
+    pull_request:
+        branches:
+            - master
+            - next
     workflow_dispatch:
 jobs:
     build-docs:
         name: "Build Sphinx docs"
         runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                python-version: ['3.7']
         steps:
             - name: Checkout Pilot 3 repo
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4.2.2
 
             - name: Setup Python
-              uses: actions/setup-python@v4
+              uses: actions/setup-python@v5.6.0
               with:
-                python-version: ${{ matrix.python-version }}
+                python-version: '3.12'
                 architecture: x64
 
             - name: Pip install
-              run: pip install sphinx
+              run: pip install sphinx furo
 
             - name: Check sphinx version
               run: python -c "import sphinx;print(sphinx.__version__)"
 
+            - name: Build docs locally to catch errors
+              run: cd doc && make html
+
             - name: Trigger panda-docs webhook
+              if: github.event_name == 'push' && github.ref == 'refs/heads/master'
               env:
                 READDOCS_TOKEN: ${{ secrets.READDOCS_TOKEN }}
                 READDOCS_HOOK: ${{ secrets.READDOCS_HOOK }}

.gitignore

@@ -12,3 +12,4 @@ build
 .idea*
 rucio_upload.json
 tools
+doc/_build/

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# .readthedocs.yaml
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: doc/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt

DIRECTORY_STRUCTURE.md

@@ -0,0 +1,23 @@
+# Directory Structure
+
+This document outlines the directory structure of the project.
+
+- **`.github/`**: Contains GitHub Actions workflow files for Continuous Integration and Continuous Deployment (CI/CD).
+- **`doc/`**: Contains documentation files for the project, likely using Sphinx.
+- **`pilot/`**: The main source code directory for the project.
+    - **`api/`**: Contains files related to the project's API.
+    - **`common/`**: Contains common utility functions and classes used across the project.
+    - **`control/`**: Houses the control logic of the application.
+    - **`copytool/`**: Includes various tools and modules for file copying operations.
+    - **`eventservice/`**: Contains files and modules related to the event service.
+    - **`info/`**: Manages information services and data handling.
+    - **`resource/`**: Contains modules for resource management.
+    - **`scripts/`**: Includes various scripts for different tasks.
+    - **`test/`**: Contains test files for the project.
+    - **`user/`**: Contains user-specific configurations and files.
+    - **`util/`**: A directory for various utility functions and modules.
+    - **`workflow/`**: Manages workflows and related tasks.
+- **`LICENSE`**: The license file for the project.
+- **`README.md`**: The main README file for the project.
+- **`requirements.txt`**: A list of Python packages required to run the project.
+- **`setup.py`**: The setup script for the project.

PILOTVERSION

@@ -1 +1 @@
-3.12.4.1
+3.13.0.23

doc/Makefile

@@ -1,27 +1,16 @@
-# Minimal makefile for Sphinx documentation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Authors:
-# - Daniel Drizhuk, d.drizhuk@gmail.com, 2017
+SPHINXOPTS  ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR   = .
+BUILDDIR    = _build
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = Pilot2
-SOURCEDIR     = .
-BUILDDIR      = _build
+.PHONY: help html clean
 
-# Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+html:
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+	@echo "Build finished. Open _build/html/index.html in a browser."
 
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+clean:
+	rm -rf $(BUILDDIR)

doc/api/api.rst

@@ -0,0 +1,42 @@
+pilot.api
+=========
+
+analytics
+---------
+
+.. automodule:: pilot.api.analytics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+data
+----
+
+.. automodule:: pilot.api.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+es_data
+-------
+
+.. automodule:: pilot.api.es_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memorymonitor
+-------------
+
+.. automodule:: pilot.api.memorymonitor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+services
+--------
+
+.. automodule:: pilot.api.services
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/api/common.rst

@@ -0,0 +1,34 @@
+pilot.common
+============
+
+errorcodes
+----------
+
+.. automodule:: pilot.common.errorcodes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+exception
+---------
+
+.. automodule:: pilot.common.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pilotcache
+----------
+
+.. automodule:: pilot.common.pilotcache
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pluginfactory
+-------------
+
+.. automodule:: pilot.common.pluginfactory
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/api/control.rst

@@ -0,0 +1,48 @@
+pilot.control
+=============
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Subpackages
+
+   control/payloads
+
+data
+----
+
+.. automodule:: pilot.control.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+interceptor
+-----------
+
+.. automodule:: pilot.control.interceptor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+job
+---
+
+.. automodule:: pilot.control.job
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monitor
+-------
+
+.. automodule:: pilot.control.monitor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+payload
+-------
+
+.. automodule:: pilot.control.payload
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/api/control/payloads.rst

@@ -0,0 +1,34 @@
+pilot.control.payloads
+======================
+
+eventservice
+------------
+
+.. automodule:: pilot.control.payloads.eventservice
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eventservicemerge
+-----------------
+
+.. automodule:: pilot.control.payloads.eventservicemerge
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+generic
+-------
+
+.. automodule:: pilot.control.payloads.generic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+kubernetesx
+-----------
+
+.. automodule:: pilot.control.payloads.kubernetesx
+   :members:
+   :undoc-members:
+   :show-inheritance: