sphinx doc versioning, dating, linking, etc for 3.1.x and test of RTD…

… build
GeminiDRSoftware · Mar 27, 2023 · 4beedd4 · 4beedd4
1 parent fa5f511
commit 4beedd4
Show file tree

Hide file tree

Showing 23 changed files with 89 additions and 85 deletions.
diff --git a/astrodata/_version.py b/astrodata/_version.py
@@ -8,7 +8,7 @@
 API = 3
 FEATURE = 1
 BUG = 0
-TAG = 'dev'
+TAG = ''
 
 
 def version(short=False, tag=TAG):

diff --git a/astrodata/doc/conf.py b/astrodata/doc/conf.py
@@ -59,10 +59,10 @@
 # The short X.Y version.
 version = '3.1'
 # The ull version, including alpha/beta/rc tags.
-#release = '3.0.x'
-#rtdurl = 'release-'+release
-release = '3.1.0-dev'
-rtdurl = 'v'+release
+release = '3.1.x'
+rtdurl = 'release-'+release
+#release = '3.1.0-dev'
+#rtdurl = 'v'+release
 
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -75,7 +75,7 @@
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #
-today = 'May 2023'
+today = 'April 2023'
 #
 # Else, today_fmt is used as the format for a strftime call.
 #

diff --git a/doc/DRAGONS/conf.py b/doc/DRAGONS/conf.py
@@ -61,18 +61,18 @@
 # The short X.Y version.
 version = '3.1'
 # The full version, including alpha/beta/rc tags.
-release = '3.1.0'
+#release = '3.1.0'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'December 2021'
+today = 'April 2023'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 

diff --git a/geminidr/doc/tutorials/F2Img-DRTutorial/01_introduction.rst b/geminidr/doc/tutorials/F2Img-DRTutorial/01_introduction.rst
@@ -8,7 +8,7 @@ Introduction
 
 This tutorial covers the basics of reducing
 `Flamingos-2 <https://www.gemini.edu/sciops/instruments/flamingos2/>`_  data
-using `DRAGONS <https://dragons.readthedocs.io/>`_.
+using |DRAGONS|.
 
 The reduction can be done in two different ways:
 
@@ -30,9 +30,8 @@ that we use throughout the tutorial.
 Software Requirements
 =====================
 
-Before you start, make sure you have `DRAGONS
-<https://dragons.readthedocs.io/>`_ properly installed and configured on your
-machine. You can test that by typing the following commands:
+Before you start, make sure you have |DRAGONS| properly installed and
+configured on your machine. You can test that by typing the following commands:
 
 .. code-block:: bash
 

diff --git a/geminidr/doc/tutorials/F2Img-DRTutorial/conf.py b/geminidr/doc/tutorials/F2Img-DRTutorial/conf.py
@@ -32,18 +32,19 @@
 
 project = 'DRAGONS Tutorial - Flamingos-2 Data Reduction'
 copyright = '2023, Association of Universities for Research in Astronomy'
-author = 'Bruno C. Quint, Kathleen Labrie'
+author = 'DRAGONS Team'
 
 # The short X.Y version
 #version = astrodata.version(short=True)
 version = '3.1'
 
 # The full version, including alpha/beta/rc tags
 #release = astrodata.version()
-release = '3.1.0-dev'
+#release = '3.1.0-dev'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
+#rtdurl = 'latest'
 
 # -- General configuration ---------------------------------------------------
 
@@ -86,7 +87,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'May 2023'
+today = 'April 2023'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -160,7 +161,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'DRAGONSTutorial-Flamingos2tut.tex', 'DRAGONS Tutorial - Flamingos-2 Data Reduction',
-     'Bruno Quint, Kathleen Labrie', 'manual'),
+     'DRAGONS Team', 'manual'),
 ]
 
 
@@ -259,5 +260,6 @@ def setup(app):
 .. |astrodatauser| replace:: :raw-html:`<a href="https://astrodata.readthedocs.io/en/{v}/usermanual/index.html" target="_blank">Astrodata User Manual</a>`
 
 .. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/">Recipe System Users Manual</a>`
+.. |DRAGONS| replace:: :raw-html:`<a href="http://dragons.readthedocs.io/en/{v}/">DRAGONS</a>`
 
 """.format(v = rtdurl)
diff --git a/...torials/F2Img-DRTutorial/DRAGONSlinks.txt → ...F2Img-DRTutorial/retired/DRAGONSlinks.txt b/...torials/F2Img-DRTutorial/DRAGONSlinks.txt → ...F2Img-DRTutorial/retired/DRAGONSlinks.txt
diff --git a/geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py b/geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py
@@ -31,18 +31,19 @@
 
 project = 'DRAGONS Tutorial<br> GMOS Imaging Data Reduction'
 copyright = '2023, Association of Universities for Research in Astronomy'
-author = 'Bruno C. Quint, Kathleen Labrie'
+author = 'DRAGONS Team'
 
 # The short X.Y version
 #version = astrodata.version(short=True)
 version = '3.1'
 
 # The full version, including alpha/beta/rc tags
 #release = astrodata.version()
-release = '3.1.0-dev'
+#release = '3.1.0-dev'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
+#rtdurl = 'latest'
 
 
 # -- General configuration ---------------------------------------------------
@@ -85,7 +86,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'May 2023'
+today = 'April 2023'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -159,7 +160,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'DRAGONSTutorial-GMOStut.tex', 'DRAGONS Tutorial - GMOS Data Reduction',
-     'Bruno Quint, Kathleen Labrie', 'manual'),
+     'DRAGONS Team', 'manual'),
 ]
 
 

diff --git a/geminidr/doc/tutorials/GMOSImg-DRTutorial/index.rst b/geminidr/doc/tutorials/GMOSImg-DRTutorial/index.rst
@@ -10,8 +10,7 @@ DRAGONS - GMOS Data Reduction Tutorial
 This is a brief tutorial on how to reduce GMOS images using DRAGONS. It is
 based on information found in the `GEMINI GMOS
 WebPage <https://www.gemini.edu/sciops/instruments/gmos/>`_ and in the
-`DRAGONS Documentation on Read The Docs <https://dragons.readthedocs.io/en/v3.0.3/>`_.
-
+|DRAGONS| Documentation
 
 .. toctree::
    :maxdepth: 2

diff --git a/...rials/GMOSImg-DRTutorial/DRAGONSlinks.txt → ...OSImg-DRTutorial/retired/DRAGONSlinks.txt b/...rials/GMOSImg-DRTutorial/DRAGONSlinks.txt → ...OSImg-DRTutorial/retired/DRAGONSlinks.txt
diff --git a/geminidr/doc/tutorials/GMOSLS-DRTutorial/01_overview.rst b/geminidr/doc/tutorials/GMOSLS-DRTutorial/01_overview.rst
@@ -12,7 +12,7 @@ spectroscopic data with DRAGONS.
 GMOS is an imager and spectrograph offering longslit spectroscopy,
 multi-object spectroscopy (MOS), and integral field spectroscopy.  This
 tutorial focuses on the longslit spectroscopy.   For a tutorial on the
-reduction of GMOS imaging data, see `GMOS Imaging Data Reduction Tutorial <http://GMOSImg-DRTutorial.readthedocs.io/en/v3.0.3>`_.
+reduction of GMOS imaging data, see |GMOSImgTut|.
 
 Here is a tutorial that you, the reader, can run and experiment with.  This
 document comes with a downloadable data package that contains all the data

diff --git a/geminidr/doc/tutorials/GMOSLS-DRTutorial/conf.py b/geminidr/doc/tutorials/GMOSLS-DRTutorial/conf.py
@@ -19,16 +19,17 @@
 
 project = 'Tutorial Series - GMOS Longslit Data Reduction with DRAGONS'
 copyright = '2023, Association of Universities for Research in Astronomy'
-author = 'Kathleen Labrie'
+author = 'DRAGONS Team'
 
 # The full version, including alpha/beta/rc tags
 version = '3.1'
-release = '3.1.0-dev'
+#release = '3.1.0-dev'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
+#rtdurl = 'latest'
 
-today = 'May 2023'
+today = 'April 2023'
 
 # -- General configuration ---------------------------------------------------
 
@@ -107,7 +108,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'TutorialSeries-GMOSLSDRDRAGONS.tex', 'Tutorial Series - GMOS Longslit Data Reduction with DRAGONS Documentation',
-     'Kathleen Labrie', 'manual'),
+     'DRAGONS Team', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -149,5 +150,7 @@ def setup(app):
 .. |atfile| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>`
 .. |astrodatauser| replace:: :raw-html:`<a href="https://astrodata.readthedocs.io/en/{v}/usermanual/index.html" target="_blank">Astrodata User Manual</a>`
 
+.. |GMOSImgTut| replace:: :raw-html:`<a href="http://GMOSImg-DRTutorial.readthedocs.io/en/{v}">GMOS Imaging Data Reduction Tutorial</a>`
+
 .. |RSUserInstall| replace:: :raw-html:`<a href="https://dragons.readthedocs.io/projects/recipe-system-users-manual/en/{v}/install.html" target="_blank">DRAGONS Installation Instructions</a>`
 """.format(v = rtdurl)
diff --git a/...orials/GMOSLS-DRTutorial/DRAGONSlinks.txt → ...MOSLS-DRTutorial/retired/DRAGONSlinks.txt b/...orials/GMOSLS-DRTutorial/DRAGONSlinks.txt → ...MOSLS-DRTutorial/retired/DRAGONSlinks.txt
diff --git a/geminidr/doc/tutorials/GNIRSImg-DRTutorial/conf.py b/geminidr/doc/tutorials/GNIRSImg-DRTutorial/conf.py
@@ -49,7 +49,7 @@
 # General information about the project.
 project = 'Tutorial Series - GNIRS Imaging Data Reduction with DRAGONS'
 copyright = '2023, Association of Universities for Research in Astronomy'
-author = 'Kathleen Labrie'
+author = 'DRAGONS Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -58,10 +58,11 @@
 # The short X.Y version.
 version = '3.1'
 # The full version, including alpha/beta/rc tags.
-release = '3.1.0-dev'
+#release = '3.1.0-dev'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
+#rtdurl = 'latest'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -72,7 +73,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'May 2023'
+today = 'April 2023'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -154,7 +155,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'TutorialSeries-GNIRSImgDRDRAGONS.tex', 'Tutorial Series - GNIRS Imaging Data Reduction with DRAGONS Documentation',
-     'Kathleen Labrie', 'manual'),
+     'DRAGONS Team', 'manual'),
 ]
 
 

diff --git a/...ials/GNIRSImg-DRTutorial/DRAGONSlinks.txt → ...RSImg-DRTutorial/retired/DRAGONSlinks.txt b/...ials/GNIRSImg-DRTutorial/DRAGONSlinks.txt → ...RSImg-DRTutorial/retired/DRAGONSlinks.txt
diff --git a/geminidr/doc/tutorials/GSAOIImg-DRTutorial/01_introduction.rst b/geminidr/doc/tutorials/GSAOIImg-DRTutorial/01_introduction.rst
@@ -8,7 +8,7 @@ Introduction
 
 This tutorial covers the basics of reducing
 `GSAOI <https://www.gemini.edu/sciops/instruments/gsaoi/>`_  data using
-`DRAGONS <https://dragons.readthedocs.io/>`_.
+|DRAGONS|.
 
 The next two sections explain what are the required software and the data set
 that we use throughout the tutorial.
@@ -27,9 +27,8 @@ We show how to run the same reduction using both methods.
 Software Requirements
 =====================
 
-Before you start, make sure you have `DRAGONS
-<https://dragons.readthedocs.io/>`_ properly installed and configured on your
-machine. You can test that by typing the following commands:
+Before you start, make sure you have |DRAGONS| properly installed and
+configured on your machine. You can test that by typing the following commands:
 
 .. code-block:: bash
 

diff --git a/geminidr/doc/tutorials/GSAOIImg-DRTutorial/conf.py b/geminidr/doc/tutorials/GSAOIImg-DRTutorial/conf.py
@@ -31,18 +31,19 @@
 
 project = 'DRAGONS Tutorial - GSAOI Data Reduction'
 copyright = '2023, Association of Universities for Research in Astronomy'
-author = 'Bruno C. Quint, Bill Vacca, Kathleen Labrie'
+author = 'DRAGONS Team'
 
 # The short X.Y version
 #version = astrodata.version(short=True)
 version = '3.1'
 
 # The full version, including alpha/beta/rc tags
 #release = astrodata.version()
-release = '3.1.0-dev'
+#release = '3.1.0-dev'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
+#rtdurl = 'latest'
 
 # -- General configuration ---------------------------------------------------
 
@@ -85,7 +86,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'May 2023'
+today = 'April 2023'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -159,7 +160,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'DRAGONSTutorial-GSAOItut.tex', 'DRAGONS Tutorial - GSAOI Data Reduction',
-     'Bruno Quint, Bill Vacca, Kathleen Labrie', 'manual'),
+     'DRAGONS Team', 'manual'),
 ]
 
 
@@ -215,8 +216,8 @@
 intersphinx_mapping = {
 #    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/latest/', None),
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/latest/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/latest/', None),
+#    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/latest/', None),
+#    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/latest/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'python': ('https://docs.python.org/3', None),
@@ -252,6 +253,7 @@ def setup(app):
 .. |atfile| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>`
 .. |astrodatauser| replace:: :raw-html:`<a href="https://astrodata.readthedocs.io/en/{v}/usermanual/index.html" target="_blank">Astrodata User Manual</a>`
 
+.. |DRAGONS| replace:: :raw-html:`<a href="http://dragons.readthedocs.io/en/{v}/">DRAGONS</a>`
 .. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/">Recipe System Users Manual</a>`
 
 """.format(v = rtdurl)
diff --git a/...ials/GSAOIImg-DRTutorial/DRAGONSlinks.txt → ...OIImg-DRTutorial/retired/DRAGONSlinks.txt b/...ials/GSAOIImg-DRTutorial/DRAGONSlinks.txt → ...OIImg-DRTutorial/retired/DRAGONSlinks.txt
diff --git a/geminidr/doc/tutorials/NIRIImg-DRTutorial/conf.py b/geminidr/doc/tutorials/NIRIImg-DRTutorial/conf.py
@@ -48,7 +48,7 @@
 # General information about the project.
 project = 'Tutorial Series - NIRI Imaging Data Reduction with DRAGONS'
 copyright = '2023, Association of Universities for Research in Astronomy'
-author = 'Kathleen Labrie'
+author = 'DRAGONS Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -57,10 +57,11 @@
 # The short X.Y version.
 version = '3.1'
 # The full version, including alpha/beta/rc tags.
-release = '3.1.0-dev'
+#release = '3.1.0-dev'
 #rtdurl = 'v'+release
-#rtdurl = 'release-'+release
-rtdurl = 'latest'
+release = '3.1.x'
+rtdurl = 'release-'+release
+#rtdurl = 'latest'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -71,7 +72,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'May 2023'
+today = 'April 2023'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -153,7 +154,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'TutorialSeries-NIRIImgDRDRAGONS.tex', 'Tutorial Series - NIRI Imaging Data Reduction with DRAGONS Documentation',
-     'Kathleen Labrie', 'manual'),
+     'DRAGONS Team', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

diff --git a/...rials/NIRIImg-DRTutorial/DRAGONSlinks.txt → ...RIImg-DRTutorial/retired/DRAGONSlinks.txt b/...rials/NIRIImg-DRTutorial/DRAGONSlinks.txt → ...RIImg-DRTutorial/retired/DRAGONSlinks.txt