diff options
author | Alex Grönholm <alex.gronholm@nextday.fi> | 2022-01-02 15:25:38 +0200 |
---|---|---|
committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2022-01-02 15:25:38 +0200 |
commit | a0e1647117225b10e3ee96f9a895ecf2fea40eaf (patch) | |
tree | 216cba565b7fb9d1e0ecc49cb3bce6c99dc73fb9 /docs | |
parent | ab8c32e0a925b6dff2974f32f645c839cdb000e0 (diff) | |
download | apscheduler-a0e1647117225b10e3ee96f9a895ecf2fea40eaf.tar.gz |
Upgraded syntax and switched linting over to pre-commit.ci
Linting checks are now run by pre-commit.ci instead of GitHub Actions.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 204 | ||||
-rw-r--r-- | docs/modules/executors/base.rst | 1 | ||||
-rw-r--r-- | docs/userguide.rst | 6 |
3 files changed, 35 insertions, 176 deletions
diff --git a/docs/conf.py b/docs/conf.py index 38eb45b..2b78efa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,198 +1,58 @@ -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# APScheduler documentation build configuration file, created by -# sphinx-quickstart on Fri Jul 31 02:56:30 2009. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -import apscheduler +from __future__ import annotations +# -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.append(os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'APScheduler' -copyright = u'Alex Grönholm' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. # -# The short X.Y version. -version = apscheduler.version -# The full version, including alpha/beta/rc tags. -release = apscheduler.release - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) -# List of documents that shouldn't be included in the build. -#unused_docs = [] -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['_build', 'build', '.tox', '.git', 'examples'] +# -- Project information ----------------------------------------------------- -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +project = 'APScheduler' +copyright = 'Alex Grönholm' +author = 'Alex Grönholm' -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True +# -- General configuration --------------------------------------------------- -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx' +] -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] -autodoc_member_order = 'alphabetical' -# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output ------------------------------------------------- -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# html_theme = 'sphinx_rtd_theme' -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - # 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_use_modindex = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'APSchedulerdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'APScheduler.tex', u'APScheduler Documentation', - u'Alex Grönholm', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True +html_static_path = ['_static'] intersphinx_mapping = {'python': ('https://docs.python.org/', None), 'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None)} diff --git a/docs/modules/executors/base.rst b/docs/modules/executors/base.rst index 5c4bfe7..255d7e6 100644 --- a/docs/modules/executors/base.rst +++ b/docs/modules/executors/base.rst @@ -8,4 +8,3 @@ Module Contents .. autoclass:: BaseExecutor :members: - diff --git a/docs/userguide.rst b/docs/userguide.rst index 7061b0c..3139857 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -422,9 +422,9 @@ job's ``misfire_grace_time`` option (which can be set on per-job basis or global scheduler) to see if the execution should still be triggered. This can lead into the job being executed several times in succession. -If this behavior is undesirable for your particular use case, it is possible to use `coalescing` to -roll all these missed executions into one. In other words, if coalescing is enabled for the job and -the scheduler sees one or more queued executions for the job, it will only trigger it once. No +If this behavior is undesirable for your particular use case, it is possible to use ``coalescing`` +to roll all these missed executions into one. In other words, if coalescing is enabled for the job +and the scheduler sees one or more queued executions for the job, it will only trigger it once. No misfire events will be sent for the "bypassed" runs. .. note:: |