Skip to content

Commit 32aac3f

Browse files
committed
BACKPORT: Build system changes, doc fixes, few attribute renames (#359)
* pyslurm.Job: add attribute run_time_remaining * pyslurm.JobStep: add run_time_remaining and elapsed_cpu_time attributes * rename __version__.py to just version.py * update doc_requirements to exclude cython 3.1.* releases * mkdocs.yml updates * move flake8 config to pyproject.toml * move away from invoking setup.py directly * build.sh: use pip install * rename pyslurm.pyx to deprecated.pyx anything in there is effectively the old api, which is considered deprecated. The name change doesn't affect anything, because all the stuff is wildcard-imported anyway. But it prevents the documentation from being built due to circular alias errors. * add first working pyslurm.spec file for building rpms * ability to provide core-count for builddocs.sh * remove configure.sh script obsolete, should use a slurm-container solution for testing and dev * remove run_tests* scripts * add cython-lint config, update flake8 config * remove cython.cfg, flake8 config is in pyproject.toml * update tox.ini * pyslurm.JobStep: rename step.alloc_cpus to step.cpus * update copyright for docs * doc: add JobStepStatistics * core job+step: fix docs
1 parent bd2f7fe commit 32aac3f

Some content is hidden

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

46 files changed

+289
-379
lines changed

cython.cfg

Lines changed: 0 additions & 13 deletions
This file was deleted.

doc_requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
cython>=3.0.0b1
1+
cython>=3.0.11,<3.1
22
wheel
33
setuptools
44
mkdocstrings[python]

docs/reference/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Config
66
This API is currently being completely reworked, and is subject to be
77
removed in the future when a replacement is introduced
88

9-
::: pyslurm.config
9+
::: pyslurm.deprecated.config

docs/reference/db/cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Cluster
66
This API is currently being completely reworked, and is subject to be
77
removed in the future when a replacement is introduced
88

9-
::: pyslurm.slurmdb_clusters
9+
::: pyslurm.deprecated.slurmdb_clusters

docs/reference/db/event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Event
66
This API is currently being completely reworked, and is subject to be
77
removed in the future when a replacement is introduced
88

9-
::: pyslurm.slurmdb_events
9+
::: pyslurm.deprecated.slurmdb_events

docs/reference/db/jobstats.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ title: JobStatistics
33
---
44

55
::: pyslurm.db.JobStatistics
6+
::: pyslurm.db.JobStepStatistics

docs/reference/db/reservation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Reservation
66
This API is currently being completely reworked, and is subject to be
77
removed in the future when a replacement is introduced
88

9-
::: pyslurm.slurmdb_reservations
9+
::: pyslurm.deprecated.slurmdb_reservations

docs/reference/frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Frontend
66
This API is currently being completely reworked, and is subject to be
77
removed in the future when a replacement is introduced
88

9-
::: pyslurm.front_end
9+
::: pyslurm.deprecated.front_end

docs/reference/hostlist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Hostlist
66
This API is currently being completely reworked, and is subject to be
77
removed in the future when a replacement is introduced
88

9-
::: pyslurm.hostlist
9+
::: pyslurm.deprecated.hostlist

docs/reference/old/db/job.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ title: Job
66
This is superseded by [pyslurm.db.Job](../../db/job.md) class and will
77
be removed in a future release
88

9-
::: pyslurm.slurmdb_jobs
9+
::: pyslurm.deprecated.slurmdb_jobs
1010
handler: python

0 commit comments

Comments
 (0)