Refactor + improve docs

CHANGELOG.md

@@ -16,9 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New attributes for a Database Job:
     - extra
     - failed_node
-- Now possible to initialize a pyslurm.db.Jobs collection with existing job
+- Now possible to initialize a [pyslurm.db.Jobs][] collection with existing job
   ids or pyslurm.db.Job objects
 - Added `as_dict` function to all Collections
+- Added a new Base Class [MultiClusterMap][pyslurm.xcollections.MultiClusterMap] that some Collections inherit from.
 
 ### Fixed
 
@@ -28,9 +29,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - the Job was older than a day
 
 ### Changed
-
-- All Collections (like [pyslurm.Jobs](https://pyslurm.github.io/23.2/reference/job/#pyslurm.Jobs)) inherit from `list` now instead of `dict`
+
 - `JobSearchFilter` has been renamed to `JobFilter`
+- Renamed `as_dict` Function of some classes to `to_dict`
 
 ## [23.2.1](https://github.com/PySlurm/pyslurm/releases/tag/v23.2.1) - 2023-05-18
 

docs/reference/config.md

@@ -7,4 +7,3 @@ title: Config
     removed in the future when a replacement is introduced
 
 ::: pyslurm.config
-    handler: python

docs/reference/constants.md

@@ -3,5 +3,3 @@ title: constants
 ---
 
 ::: pyslurm.constants
-    handler: python
-

docs/reference/db/cluster.md

@@ -7,4 +7,3 @@ title: Cluster
     removed in the future when a replacement is introduced
 
 ::: pyslurm.slurmdb_clusters
-    handler: python

docs/reference/db/connection.md

@@ -3,4 +3,3 @@ title: Connection
 ---
 
 ::: pyslurm.db.Connection
-    handler: python

docs/reference/db/event.md

@@ -7,4 +7,3 @@ title: Event
     removed in the future when a replacement is introduced
 
 ::: pyslurm.slurmdb_events
-    handler: python

docs/reference/db/job.md

@@ -7,7 +7,4 @@ title: Job
     will be removed in a future release
 
 ::: pyslurm.db.Job
-    handler: python
-
 ::: pyslurm.db.Jobs
-    handler: python

docs/reference/db/jobfilter.md

@@ -3,4 +3,3 @@ title: JobFilter
 ---
 
 ::: pyslurm.db.JobFilter
-    handler: python

docs/reference/db/jobstats.md

@@ -3,4 +3,3 @@ title: JobStatistics
 ---
 
 ::: pyslurm.db.JobStatistics
-    handler: python

docs/reference/db/jobstep.md

@@ -3,7 +3,4 @@ title: JobStep
 ---
 
 ::: pyslurm.db.JobStep
-    handler: python
-
 ::: pyslurm.db.JobSteps
-    handler: python

docs/reference/db/reservation.md

@@ -7,4 +7,3 @@ title: Reservation
     removed in the future when a replacement is introduced
 
 ::: pyslurm.slurmdb_reservations
-    handler: python

docs/reference/exceptions.md

@@ -3,7 +3,4 @@ title: Exceptions
 ---
 
 ::: pyslurm.PyslurmError
-    handler: python
-
 ::: pyslurm.RPCError
-    handler: python

docs/reference/frontend.md

@@ -7,4 +7,3 @@ title: Frontend
     removed in the future when a replacement is introduced
 
 ::: pyslurm.front_end
-    handler: python

docs/reference/hostlist.md

@@ -7,4 +7,3 @@ title: Hostlist
     removed in the future when a replacement is introduced
 
 ::: pyslurm.hostlist
-    handler: python

docs/reference/job.md

@@ -7,7 +7,4 @@ title: Job
     removed in a future release
 
 ::: pyslurm.Job
-    handler: python
-
 ::: pyslurm.Jobs
-    handler: python

docs/reference/jobstep.md

@@ -7,7 +7,4 @@ title: JobStep
     will be removed in a future release
 
 ::: pyslurm.JobStep
-    handler: python
-
 ::: pyslurm.JobSteps
-    handler: python

docs/reference/jobsubmitdescription.md

@@ -3,4 +3,3 @@ title: JobSubmitDescription
 ---
 
 ::: pyslurm.JobSubmitDescription
-    handler: python

docs/reference/node.md

@@ -7,7 +7,4 @@ title: Node
     removed in a future release
 
 ::: pyslurm.Node
-    handler: python
-
 ::: pyslurm.Nodes
-    handler: python

docs/reference/partition.md

@@ -7,7 +7,4 @@ title: Partition
     will be removed in a future release
 
 ::: pyslurm.Partition
-    handler: python
-
 ::: pyslurm.Partitions
-    handler: python

docs/reference/reservation.md

@@ -7,4 +7,3 @@ title: Reservation
     removed in the future when a replacement is introduced
 
 ::: pyslurm.reservation
-    handler: python

docs/reference/statistics.md

@@ -7,4 +7,3 @@ title: Statistics
     removed in the future when a replacement is introduced
 
 ::: pyslurm.statistics
-    handler: python

docs/reference/topology.md

@@ -7,4 +7,3 @@ title: Topology
     removed in the future when a replacement is introduced
 
 ::: pyslurm.topology
-    handler: python

docs/reference/trigger.md

@@ -7,4 +7,3 @@ title: Trigger
     removed in the future when a replacement is introduced
 
 ::: pyslurm.trigger
-    handler: python

docs/reference/utilities.md

@@ -3,37 +3,17 @@ title: utils
 ---
 
 ::: pyslurm.utils
-    handler: python
+    options:
+        members: []
 
 ::: pyslurm.utils.timestr_to_secs
-    handler: python
-
 ::: pyslurm.utils.timestr_to_mins
-    handler: python
-
 ::: pyslurm.utils.secs_to_timestr
-    handler: python
-
 ::: pyslurm.utils.mins_to_timestr
-    handler: python
-
 ::: pyslurm.utils.date_to_timestamp
-    handler: python
-
 ::: pyslurm.utils.timestamp_to_date
-    handler: python
-
 ::: pyslurm.utils.expand_range_str
-    handler: python
-
 ::: pyslurm.utils.humanize
-    handler: python
-
 ::: pyslurm.utils.dehumanize
-    handler: python
-
 ::: pyslurm.utils.nodelist_from_range_str
-    handler: python
-
 ::: pyslurm.utils.nodelist_to_range_str
-    handler: python

docs/reference/xcollections.md

@@ -0,0 +1,16 @@
+---
+title: xcollections
+---
+
+::: pyslurm.xcollections
+    handler: python
+    options:
+        members:
+            - MultiClusterMap
+            - BaseView
+            - KeysView
+            - MCKeysView
+            - ItemsView
+            - MCItemsView
+            - ValuesView
+            - ClustersView

docs/stylesheets/extra.css

@@ -2,3 +2,9 @@
 .md-grid {
   max-width: 75%; 
 }
+
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: .05rem solid var(--md-typeset-table-color);
+}

mkdocs.yml

@@ -56,6 +56,8 @@ plugins:
             docstring_style: google
             show_signature: true
             show_root_heading: true
+            show_symbol_type_toc: true
+            show_symbol_type_heading: true
 
 markdown_extensions:
   - admonition

pyslurm/core/job/job.pxd

@@ -25,14 +25,12 @@
 from pyslurm.utils cimport cstr, ctime
 from pyslurm.utils.uint cimport *
 from pyslurm.utils.ctime cimport time_t
-
 from libc.string cimport memcpy, memset
 from libc.stdint cimport uint8_t, uint16_t, uint32_t, uint64_t, int64_t
 from libc.stdlib cimport free
-
 from pyslurm.core.job.submission cimport JobSubmitDescription
 from pyslurm.core.job.step cimport JobSteps, JobStep
-
+from pyslurm.xcollections cimport MultiClusterMap
 from pyslurm cimport slurm
 from pyslurm.slurm cimport (
     working_cluster_rec,
@@ -67,8 +65,8 @@ from pyslurm.slurm cimport (
 )
 
 
-cdef class Jobs(list):
-    """A collection of [pyslurm.Job][] objects.
+cdef class Jobs(MultiClusterMap):
+    """A [`Multi Cluster`][pyslurm.xcollections.MultiClusterMap] collection of [pyslurm.Job][] objects.
 
     Args:
         jobs (Union[list, dict], optional=None):
@@ -90,7 +88,7 @@ cdef class Jobs(list):
             This is the result of multiplying the run_time with the amount of
             cpus for each job.
         frozen (bool):
-            If this is set to True and the reload() method is called, then
+            If this is set to True and the `reload()` method is called, then
             *ONLY* Jobs that already exist in this collection will be
             reloaded. New Jobs that are discovered will not be added to this
             collection, but old Jobs which have already been purged from the
@@ -115,15 +113,12 @@ cdef class Job:
         job_id (int):
             An Integer representing a Job-ID.
 
-    Raises:
-        MemoryError: If malloc fails to allocate memory.
-
     Attributes:
         steps (JobSteps):
             Steps this Job has.
             Before you can access the Steps data for a Job, you have to call
-            the reload() method of a Job instance or the load_steps() method
-            of a Jobs collection.
+            the `reload()` method of a Job instance or the `load_steps()`
+            method of a Jobs collection.
         name (str):
             Name of the Job
         id (int):