Merge pull request #295 from nabobalis/docs

HinodeXRT · Dec 12, 2024 · 7697c29 · 7697c29
2 parents e2d58d3 + 5f0c720
commit 7697c29
Show file tree

Hide file tree

Showing 85 changed files with 1,155 additions and 4,958 deletions.
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -92,21 +92,13 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.10'
+        python-version: '3.12'
 
     - name: Install nox
       run: python -m pip install --progress-bar off --upgrade nox
 
     - name: Install graphviz
       run: sudo apt install graphviz
 
-    - name: Install pandoc
-      run: |
-        PANDOC_VERSION="3.1.11.1"
-        wget -q https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-1-amd64.deb
-        sudo dpkg -i pandoc-${PANDOC_VERSION}-1-amd64.deb
-        rm pandoc-${PANDOC_VERSION}-1-amd64.deb
-        pandoc --version
-
     - name: Build documentation
       run: nox -s docs
diff --git a/.gitignore b/.gitignore
@@ -69,7 +69,9 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/generated
+docs/sg_execution_times.rst
+docs/_build
 docs/api
 
 # PyBuilder

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,7 +28,7 @@ repos:
   - id: check-github-workflows
 
 - repo: https://github.com/sirosen/texthooks
-  rev: 0.6.7
+  rev: 0.6.8
   hooks:
   - id: fix-smartquotes
   - id: fix-spaces
@@ -40,6 +40,7 @@ repos:
   hooks:
   - id: remove-crlf
     name: remove CRLF line endings
+
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
   rev: v2.14.0
   hooks:
@@ -48,12 +49,6 @@ repos:
   - id: pretty-format-yaml
     args: [--autofix]
 
-- repo: https://github.com/MarcoGorelli/absolufy-imports
-  rev: v0.3.1
-  hooks:
-  - id: absolufy-imports
-    name: Use absolute rather than relative imports
-
 - repo: https://github.com/pre-commit/pygrep-hooks
   rev: v1.10.0
   hooks:
@@ -72,7 +67,7 @@ repos:
     exclude: .*\.fits
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.8.1
+  rev: v0.8.3
   hooks:
   - id: ruff
     name: ruff
@@ -87,12 +82,3 @@ repos:
     name: autoformat code blocks in docs
     additional_dependencies:
     - black
-
-- repo: https://github.com/nbQA-dev/nbQA
-  rev: 1.9.1
-  hooks:
-  - id: nbqa-check-ast
-    name: validate Python notebooks
-  - id: nbqa-black
-    additional_dependencies:
-    - black
diff --git a/.ruff.toml b/.ruff.toml
@@ -74,3 +74,6 @@ ignore = [
   "E402",  # Module imports not at top of file
   "INP001",  # Implicit-namespace-package. The examples are not a package.
 ]
+"examples/*" = [
+  "INP001",  # Implicit-namespace-package. The examples are not a package.
+]
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2021–2023, XRTpy contributors
+Copyright (c) 2021-2024, XRTpy contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/changelog/139.removal.rst b/changelog/139.removal.rst
diff --git a/changelog/187.doc.rst b/changelog/187.doc.rst
diff --git a/changelog/README.md b/changelog/README.md
diff --git a/docs/CODE_OF_CONDUCT.rst b/docs/CODE_OF_CONDUCT.rst
diff --git a/docs/Makefile b/docs/Makefile
@@ -14,6 +14,15 @@ help:
 
 .PHONY: help Makefile
 
+html-noplot:
+	@$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+clean:
+	rm -rf $(BUILDDIR)
+	rm -rf ./generated
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

diff --git a/docs/_static/css/admonition_color_contrast.css b/docs/_static/css/admonition_color_contrast.css