Documentation Refactor

.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 build_docs_nitpicky -- -q

.gitignore

@@ -69,7 +69,9 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/generated
+docs/sg_execution_times.rst
+docs/_build
 docs/api
 
 # PyBuilder

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

README.md

@@ -5,10 +5,8 @@
 [![Read the Docs Status](https://readthedocs.org/projects/xrtpy/badge/?version=latest&logo=twitter)](http://xrtpy.readthedocs.io/en/latest/?badge=latest)
 [![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat&logo=astropy)](http://www.astropy.org/)
 
-XRTpy is a Python package being developed for the analysis of observations
-made by the X-Ray Telescope (XRT) on the *Hinode* spacecraft.
+XRTpy is a Python package being developed for the analysis of observations made by the X-Ray Telescope (XRT) on the *Hinode* spacecraft.
 
 ## Acknowledgements
 
-The development of XRTpy is supported by NASA contract NNM07AB07C to the
-Smithsonian Astrophysical Observatory.
+The development of XRTpy is supported by NASA contract NNM07AB07C to the Smithsonian Astrophysical Observatory.

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