Package maintenance

Author: tomasstolker

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 Tomas Stolker
+Copyright (c) 2026 Tomas Stolker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -25,7 +25,7 @@ Contributions are welcome so please consider `forking <https://help.github.com/e
 License
 -------
 
-Copyright 2025 Tomas Stolker
+Copyright 2026 Tomas Stolker
 
 *diskmap* is distributed under the MIT License. See the LICENSE file for the terms and conditions.
 

docs/conf.py

@@ -7,80 +7,74 @@
 # -- 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.
+# add these directories to sys.path here.
 
-import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent.parent.resolve()))
 
 # -- Project information -----------------------------------------------------
 
-project = 'diskmap'
-copyright = '2025, Tomas Stolker'
-author = 'Tomas Stolker'
+project = "diskmap"
+copyright = "2026, Tomas Stolker"
+author = "Tomas Stolker"
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
 # ones.
+
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
-    'sphinx_automodapi.automodapi',
-    'nbsphinx'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx_automodapi.automodapi",
+    "nbsphinx"
 ]
 
+# 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 = ["_build",
+                    "Thumbs.db",
+                    ".DS_Store",
+                    ".ipynb_checkpoints/*"]
+
 # Disable notebook timeout
 nbsphinx_timeout = -1
 
 # Allow errors from notebooks
 nbsphinx_allow_errors = True
 
-autoclass_content = 'both'
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = []
-
-# 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 = ['_build',
-                    'Thumbs.db',
-                    '.DS_Store',
-                    '.ipynb_checkpoints/*']
+autoclass_content = "both"
 
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_book_theme'
+html_theme = "sphinxawesome_theme"
 
 html_theme_options = {
-    'path_to_docs': 'docs',
-    'repository_url': 'https://github.com/tomasstolker/diskmap',
-    'repository_branch': 'main',
-    'launch_buttons': {
-        'notebook_interface': 'jupyterlab',
+    "show_breadcrumbs": True,
+    "show_scrolltop": True,
+    "show_prev_next": True,
+    "main_nav_links": {
+        "GitHub": "https://github.com/tomasstolker/diskmap",
+        "PyPI": "https://pypi.org/project/diskmap/",
     },
-    'use_edit_page_button': True,
-    'use_issues_button': True,
-    'use_repository_button': True,
-    'use_download_button': True,
 }
 
-# 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 = []
+html_context = {
+    "github_user": "tomasstolker",
+    "github_repo": "diskmap",
+    "github_version": "main",
+    "doc_path": "docs",
+}
 
-html_logo = 'logo.png'
-html_search_language = 'en'
+html_static_path = []
 
-html_context = {'display_github': True,
-                'github_user': 'tomasstolker',
-                'github_repo': 'diskmap',
-                'github_version': 'main/docs/'}
+html_logo = "logo.png"
+html_search_language = "en"

docs/index.rst

@@ -3,10 +3,11 @@
 Documentation for *diskmap*
 ===========================
 
-*diskmap* is a tool for scattered light mapping of protoplanetary disks.
+*diskmap* is a tool for scattered light mapping of protoplanetary disks
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+   :hidden:
 
    installation
    tutorial.ipynb

docs/tutorial.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Tutorial for *diskmap*"
+    "# Tutorial"
    ]
   },
   {
@@ -686,7 +686,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.0"
+   "version": "3.13.7"
   }
  },
  "nbformat": 4,

pyproject.toml

@@ -31,7 +31,7 @@ docs = [
     "pandoc",
     "sphinx",
     "sphinx-automodapi",
-    "sphinx_book_theme",
+    "sphinxawesome-theme",
 ]
 test = [
     "black",