diff --git a/docs/source/conf.py b/docs/source/conf.py index fc3caf24..35bc6d55 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -41,6 +41,9 @@ templates_path = ["_templates"] autoapi_template_dir = "source/autoapi_templates" +# Remove warnings for auto API template. +exclude_patterns = ["autoapi_templates/index.rst"] + # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # @@ -52,7 +55,7 @@ # General information about the project. project = "e3-core" -copyright = "2017, AdaCore" # noqa: A001 +project_copyright = "2017, AdaCore" author = "AdaCore" # The version info for the project you're documenting, acts as replacement for @@ -60,9 +63,9 @@ # built documents. # # The short X.Y version. -version = "21.0" +version = "24.0" # The full version, including alpha/beta/rc tags. -release = "21.0" +release = "24.0" # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" @@ -75,11 +78,11 @@ html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] +# html_static_path = ["_static"] +html_static_path = [] # -- Options for HTMLHelp output ------------------------------------------ diff --git a/src/e3/job/walk.py b/src/e3/job/walk.py index db0459bf..34b52580 100644 --- a/src/e3/job/walk.py +++ b/src/e3/job/walk.py @@ -20,6 +20,8 @@ class Walk: """An abstract class scheduling and executing a DAG of actions. + .. |ReturnValue| replace:: :class:`~e3.anod.status.ReturnValue` + :ivar actions: DAG of actions to perform. :vartype actions: DAG :ivar prev_fingerprints: A dict of e3.fingerprint.Fingerprint objects, @@ -35,13 +37,13 @@ class Walk: (with the job corresponding to a given entry in the DAG of actions). :vartype new_fingerprints: dict[str, Fingerprint | None] - :ivar job_status: A dictionary of job status (ReturnValue), indexed by + :ivar job_status: A dictionary of job status (|ReturnValue|), indexed by job unique IDs. - :vartype job_status: dict[str, ReturnValue] + :vartype job_status: dict[str, |ReturnValue|] :ivar scheduler: The scheduler used to schedule and execute all the actions. :vartype scheduler: e3.job.scheduler.Scheduler - """ + """ # noqa RST304 def __init__(self, actions: DAG): """Object initializer.