Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Nov 22, 2023
1 parent 2be4914 commit 14c4085
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 40 deletions.
73 changes: 37 additions & 36 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

sys.path.insert(0, os.path.abspath(".."))
if os.environ.get("READTHEDOCS") and "ESMFMKFILE" not in os.environ:
# RTD doesn't activate the env, and esmpy depends on an env var set there
# We assume the `os` package is in {ENV}/lib/pythonX.X/os.py
Expand All @@ -38,15 +39,15 @@
# 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.autosectionlabel',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.todo',
'sphinx_codeautolink',
'sphinx_copybutton',
"nbsphinx"
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx.ext.todo",
"sphinx_codeautolink",
"sphinx_copybutton",
"nbsphinx",
]

autosectionlabel_prefix_document = True
Expand Down Expand Up @@ -76,22 +77,22 @@
}

# Generate documentation from Jupyter notebooks.
nbsphinx_execute = 'always'
nbsphinx_execute = "always"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst']
source_suffix = [".rst"]

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = 'xHydro'
project = "xHydro"
copyright = "2023, Thomas-Charles Fortier Filion"
author = "Thomas-Charles Fortier Filion"

Expand All @@ -114,10 +115,10 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
Expand All @@ -128,7 +129,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'furo'
html_theme = "furo"

# 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
Expand All @@ -145,7 +146,7 @@
# -- Options for HTMLHelp output ---------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'xhydrodoc'
htmlhelp_basename = "xhydrodoc"


# -- Options for LaTeX output ------------------------------------------
Expand All @@ -154,15 +155,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -172,21 +170,21 @@
# (source start file, target name, title, author, documentclass
# [howto, manual, or own class]).
latex_documents = [
(master_doc, 'xhydro.tex',
'xHydro Documentation',
'Thomas-Charles Fortier Filion', 'manual'),
(
master_doc,
"xhydro.tex",
"xHydro Documentation",
"Thomas-Charles Fortier Filion",
"manual",
),
]


# -- Options for manual page output ------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'xhydro',
'xHydro Documentation',
[author], 1)
]
man_pages = [(master_doc, "xhydro", "xHydro Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------
Expand All @@ -195,10 +193,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'xhydro',
'xHydro Documentation',
author,
'xhydro',
'Hydrological analysis library built with xarray.',
'hydrology'),
(
master_doc,
"xhydro",
"xHydro Documentation",
author,
"xhydro",
"Hydrological analysis library built with xarray.",
"hydrology",
),
]
5 changes: 2 additions & 3 deletions xhydro/cc.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
"""Module to compute climate change statistics using xscen functions."""

# Special imports from xscen
from xscen import (
climatological_mean, # FIXME: To be replaced with climatological_op once available
)
from xscen import \
climatological_mean # FIXME: To be replaced with climatological_op once available
from xscen import compute_deltas, ensemble_stats, produce_horizon

__all__ = [
Expand Down
1 change: 0 additions & 1 deletion xhydro/indicators.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import xclim as xc
import xscen as xs
from xclim.core.units import rate2amount

# Special imports from xscen
from xscen import compute_indicators

Expand Down

0 comments on commit 14c4085

Please sign in to comment.