Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates from the package template #764

Merged
merged 3 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/sunpy/package-template",
"commit": "c1efeecc741705d6a87ab17ca3662428df783a6d",
"commit": "17602ec8f8d4a4c5722bca00e255e480683f5096",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
repos:
# This should be before any formatting hooks like isort
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.6.5"
rev: "v0.6.7"
hooks:
- id: ruff
args: ["--fix"]
Expand Down
28 changes: 18 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Configuration file for the Sphinx documentation builder.
import os
import warnings
from datetime import datetime
import datetime

from astropy.utils.exceptions import AstropyDeprecationWarning
from matplotlib import MatplotlibDeprecationWarning
Expand All @@ -13,22 +13,30 @@
if on_rtd:
os.environ['HIDE_PARFIVE_PROGESS'] = 'True'

# -- Project information
project = 'ndcube'
author = 'The SunPy Community'
copyright = f'{datetime.now().year}, {author}'
# -- Project information -----------------------------------------------------

# The full version, including alpha/beta/rc tags
from ndcube import __version__ # NOQA
from ndcube import __version__

release = __version__
ndcube_version = Version(__version__)
is_release = not(ndcube_version.is_prerelease or ndcube_version.is_devrelease)
_version = Version(__version__)
version = release = str(_version)
# Avoid "post" appearing in version string in rendered docs
if _version.is_postrelease:
version = release = _version.base_version
# Avoid long githashes in rendered Sphinx docs
elif _version.is_devrelease:
version = release = f'{_version.base_version}.dev{_version.dev}'
is_development = _version.is_devrelease

project = "ndcube"
author = "The SunPy Community"
copyright = f'{datetime.datetime.now().year}, {author}' # noqa: A001

warnings.filterwarnings("error", category=MatplotlibDeprecationWarning)
warnings.filterwarnings("error", category=AstropyDeprecationWarning)

# -- General configuration
# -- General configuration ---------------------------------------------------

extensions = [
'matplotlib.sphinxext.plot_directive',
'sphinx.ext.autodoc',
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ tests = [
docs = [
"sphinx",
"sphinx-automodapi",
"packaging",
"matplotlib",
"mpl-animators>=1.0",
"sphinx-changelog>=1.1.0",
Expand Down
Loading