Skip to content

Commit

Permalink
Appease pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mwcraig committed Sep 29, 2024
1 parent fc29eed commit e3b4944
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 34 deletions.
7 changes: 3 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
exclude: '^/ccdproc/extern/.*.py|.*\.fits?$'
exclude: 'ccdproc/extern/.*.py|.*\.fits?$'
# ^/ccdproc/extern/.*.py # Ignore files in the extern directory
# | .*\.fits?$ # Ignore FITS files
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
rev: v4.6.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
Expand All @@ -13,7 +13,7 @@ repos:
# Per the ruff documentation, this should be before black
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.6.7
rev: v0.6.8
hooks:
# Run the linter.
- id: ruff
Expand All @@ -29,7 +29,6 @@ repos:
# pre-commit's default_language_version, see
# https://pre-commit.com/#top_level-default_language_version
language_version: python3.12
extend-exclude: '^/ccdproc/extern/.*.py|.*\.fits?$'

# Make pre-commit-ci more reasonable
ci:
Expand Down
1 change: 0 additions & 1 deletion ccdproc/tests/data/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ Data directory
This directory contains data files included with the affiliated package source
code distribution. Note that this is intended only for relatively small files
- large files should be externally hosted and downloaded as needed.

1 change: 0 additions & 1 deletion docs/_static/ccdproc.css
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ div.topbar a.brand {
background-size: 32px 32px;

}

2 changes: 1 addition & 1 deletion docs/_templates/autosummary/base.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{% extends "autosummary_core/base.rst" %}
{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
2 changes: 1 addition & 1 deletion docs/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{% extends "autosummary_core/class.rst" %}
{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
2 changes: 1 addition & 1 deletion docs/_templates/autosummary/module.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{% extends "autosummary_core/module.rst" %}
{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
51 changes: 27 additions & 24 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
# Licensed under a 3-clause BSD style license - see LICENSE.rst
#
# Astropy documentation build configuration file.
Expand Down Expand Up @@ -28,12 +27,16 @@
import datetime
import sys
from importlib import import_module
from os.path import join
from pathlib import Path

try:
from sphinx_astropy.conf.v1 import * # noqa
except ImportError:
print('ERROR: the documentation requires the sphinx-astropy package to be installed')
print(
"ERROR: the documentation requires the sphinx-astropy "
"package to be installed"
)
sys.exit(1)

if sys.version_info < (3, 11):
Expand All @@ -50,7 +53,7 @@
# -- General configuration ----------------------------------------------------

# By default, highlight as Python 3.
highlight_language = 'python3'
highlight_language = "python3"

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.2'
Expand All @@ -61,7 +64,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns.append('_templates')
exclude_patterns.append("_templates")

# This is added to the end of RST files - a good place to put substitutions to
# be used globally.
Expand Down Expand Up @@ -103,64 +106,64 @@

# Add any paths that contain custom themes here, relative to this directory.
# To use a different custom theme, add the directory containing the theme.
#html_theme_path = []
# html_theme_path = []

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. To override the custom theme, set this to the
# name of a builtin theme or the name of a custom theme in html_theme_path.
#html_theme = 'bootstrap-ccdproc'
# html_theme = 'bootstrap-ccdproc'


html_theme_options = {
'logotext1': 'ccd', # white, semi-bold
'logotext2': 'proc', # orange, light
'logotext3': ':docs' # white, light
"logotext1": "ccd", # white, semi-bold
"logotext2": "proc", # orange, light
"logotext3": ":docs", # white, light
}


# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = ''
# html_logo = ''

# 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 = ''
from os.path import join
html_favicon = join('_static', 'ccd_proc.ico')
# html_favicon = ''

html_favicon = join("_static", "ccd_proc.ico")

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = ''
# html_last_updated_fmt = ''

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = '{0} v{1}'.format(project, release)
html_title = f"{project} v{release}"

# Output file base name for HTML help builder.
htmlhelp_basename = project + 'doc'
htmlhelp_basename = project + "doc"

# Static files to copy after template files
html_static_path = ['_static']
html_style = 'ccdproc.css'
html_static_path = ["_static"]
html_style = "ccdproc.css"

# -- Options for LaTeX output -------------------------------------------------

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [('index', project + '.tex', project + u' Documentation',
author, 'manual')]
latex_documents = [
("index", project + ".tex", project + " Documentation", author, "manual")
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', project.lower(), project + u' Documentation',
[author], 1)]
man_pages = [("index", project.lower(), project + " Documentation", [author], 1)]


# -- Options for the edit_on_github extension ---------------------------------
Expand All @@ -179,7 +182,7 @@
# edit_on_github_doc_root = "docs"

# -- Resolving issue number to links in changelog -----------------------------
github_issues_url = 'https://github.com/astropy/ccdproc/issues/'
github_issues_url = "https://github.com/astropy/ccdproc/issues/"

# -- Turn on nitpicky mode for sphinx (to warn about references not found) ----
#
Expand Down
1 change: 0 additions & 1 deletion docs/reduction_examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ Here are some examples and different repositories using `ccdproc`.
.. _reduceccd: https://github.com/rgbIAA/reduceccd
.. _astrolib: https://github.com/yucelkilic/astrolib
.. _mont4k_reduction: https://github.com/bjweiner/ARTN/tree/master/mont4k_pipeline

0 comments on commit e3b4944

Please sign in to comment.