fixed inter doc sphinx link to match RTD URL. (different for branches…

… vs tags)
GeminiDRSoftware · Sep 27, 2021 · 4fa8c01 · 4fa8c01
1 parent 0c499b9
commit 4fa8c01
Show file tree

Hide file tree

Showing 13 changed files with 151 additions and 127 deletions.
diff --git a/astrodata/doc/ad_CheatSheet/conf.py b/astrodata/doc/ad_CheatSheet/conf.py
@@ -62,6 +62,8 @@
 version = '3.0'
 # The full version, including alpha/beta/rc tags.
 release = '3.0.0'
+rtdurl = 'v'+release
+#rtdurl = 'release-'+release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -261,10 +263,10 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/release-3.0.0/', None),
+    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.0/', None),
     'astropy': ('https://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.0/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.0/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.0/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.0/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://numpy.org/doc/stable/', None),
     'python': ('https://docs.python.org/3/', None),

diff --git a/astrodata/doc/ad_ProgManual/conf.py b/astrodata/doc/ad_ProgManual/conf.py
@@ -74,6 +74,8 @@
 version = '3.0'
 # The ull version, including alpha/beta/rc tags.
 release = '3.0.0'
+rtdurl = 'v'+release
+#rtdurl = 'release-'+release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -373,7 +375,7 @@ def setup(app):
 .. role:: raw-html(raw)
    :format: html
 
-.. |RSProgShow| replace:: :raw-html:`<a href="https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-{v}/">https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-{v}/</a>`
+.. |RSProgShow| replace:: :raw-html:`<a href="https://dragons-recipe-system-programmers-manual.readthedocs.io/en/{v}/">https://dragons-recipe-system-programmers-manual.readthedocs.io/en/{v}/</a>`
 
 
-""".format(v = release)
+""".format(v = rtdurl)
diff --git a/astrodata/doc/ad_UserManual/conf.py b/astrodata/doc/ad_UserManual/conf.py
@@ -73,6 +73,8 @@
 version = '3.0'
 # The full version, including alpha/beta/rc tags.
 release = '3.0.0'
+rtdurl = 'v'+release
+#rtdurl = 'release-'+release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -277,8 +279,8 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.0/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.0/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.0/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.0/', None),
     'numpy': ('http://docs.scipy.org/doc/numpy/', None),
     'python': ('https://docs.python.org/3', None),
 }

diff --git a/doc/DRAGONS/conf.py b/doc/DRAGONS/conf.py
@@ -62,6 +62,8 @@
 version = '3.0'
 # The full version, including alpha/beta/rc tags.
 release = '3.0.0'
+rtdurl = 'v'+release
+#rtdurl = 'release-'+release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -284,20 +286,20 @@ def setup(app):
 .. role:: raw-html(raw)
    :format: html
 
-.. |GMOSImgTut| replace:: :raw-html:`<a href="http://GMOSImg-DRTutorial.readthedocs.io/en/release-{v}">GMOS Imaging Data Reduction Tutorial</a>`
-.. |NIRIImgTut| replace:: :raw-html:`<a href="http://NIRIImg-DRTutorial.readthedocs.io/en/release-{v}">NIRI Imaging Data Reduction Tutorial</a>`
-.. |F2ImgTut| replace:: :raw-html:`<a href="http://F2Img-DRTutorial.readthedocs.io/en/release-{v}">Flamingos-2 Imaging Data Reduction Tutorial</a>`
-.. |GSAOIImgTut| replace:: :raw-html:`<a href="http://GSAOIImg-DRTutorial.readthedocs.io/en/release-{v}">GSAOI Imaging Data Reduction Tutorial</a>`
-.. |GNIRSImgTut| replace:: :raw-html:`<a href="http://GNIRSImg-DRTutorial.readthedocs.io/en/release-{v}">GNIRS Keyhole Imaging Data Reduction Tutorial</a>`
+.. |GMOSImgTut| replace:: :raw-html:`<a href="http://GMOSImg-DRTutorial.readthedocs.io/en/{v}">GMOS Imaging Data Reduction Tutorial</a>`
+.. |NIRIImgTut| replace:: :raw-html:`<a href="http://NIRIImg-DRTutorial.readthedocs.io/en/{v}">NIRI Imaging Data Reduction Tutorial</a>`
+.. |F2ImgTut| replace:: :raw-html:`<a href="http://F2Img-DRTutorial.readthedocs.io/en/{v}">Flamingos-2 Imaging Data Reduction Tutorial</a>`
+.. |GSAOIImgTut| replace:: :raw-html:`<a href="http://GSAOIImg-DRTutorial.readthedocs.io/en/{v}">GSAOI Imaging Data Reduction Tutorial</a>`
+.. |GNIRSImgTut| replace:: :raw-html:`<a href="http://GNIRSImg-DRTutorial.readthedocs.io/en/{v}">GNIRS Keyhole Imaging Data Reduction Tutorial</a>`
 
-.. |ADCheat| replace:: :raw-html:`<a href="http://astrodata-cheat-sheet.readthedocs.io/en/release-{v}/">AstroData Cheat Sheet</a>`
-.. |ADUser| replace:: :raw-html:`<a href="http://astrodata-user-manual.readthedocs.io/en/release-{v}/">Astrodata User Manual</a>`
-.. |ADProg| replace:: :raw-html:`<a href="http://astrodata-programmer-manual.readthedocs.io/en/release-{v}/">Astrodata Programmer Manual</a>`
-.. |RSProg| replace:: :raw-html:`<a href="http://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-{v}/">Recipe System Programmers Manual</a>`
-.. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/">Recipe System Users Manual</a>`
+.. |ADCheat| replace:: :raw-html:`<a href="http://astrodata-cheat-sheet.readthedocs.io/en/{v}/">AstroData Cheat Sheet</a>`
+.. |ADUser| replace:: :raw-html:`<a href="http://astrodata-user-manual.readthedocs.io/en/{v}/">Astrodata User Manual</a>`
+.. |ADProg| replace:: :raw-html:`<a href="http://astrodata-programmer-manual.readthedocs.io/en/{v}/">Astrodata Programmer Manual</a>`
+.. |RSProg| replace:: :raw-html:`<a href="http://dragons-recipe-system-programmers-manual.readthedocs.io/en/{v}/">Recipe System Programmers Manual</a>`
+.. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/">Recipe System Users Manual</a>`
 
 .. |WSBasicDRAGONS| replace:: :raw-html:`<a href="https://collection-of-dragons-workshops.readthedocs.io/en/latest/BasicDRAGONS-2hr/sphinx/index.html">Basic DRAGONS Workshop</a>`
 
-.. |RSUserShow|  replace:: http://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/
+.. |RSUserShow|  replace:: http://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/
 
-""".format(v = release)
+""".format(v = rtdurl)
diff --git a/geminidr/doc/tutorials/F2Img-DRTutorial/conf.py b/geminidr/doc/tutorials/F2Img-DRTutorial/conf.py
@@ -40,6 +40,8 @@
 # The full version, including alpha/beta/rc tags
 #release = astrodata.version()
 release = '3.0.0'
+rtdurl = 'v'+release
+#rtdurl = 'release-'+release
 
 
 # -- General configuration ---------------------------------------------------
@@ -211,10 +213,10 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/release-3.0.0/', None),
+    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.0/', None),
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.0/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.0/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.0/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.0/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'python': ('https://docs.python.org/3', None),
@@ -243,18 +245,18 @@ def setup(app):
 .. role:: raw-html(raw)
    :format: html
 
-.. |caldb| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/caldb.html" target="_blank">caldb</a>`
-.. |dataselect| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#dataselect" target="_blank">dataselect</a>`
-.. |descriptors| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/release-{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
-.. |descriptor| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/release-{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
-.. |reduce| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/reduce.html" target="_blank">reduce</a>`
-.. |showd| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#showd" target"_blank">showd</a>`
-.. |showrecipes| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#showrecipes" target="_blank">showrecipes</a>`
-.. |showpars| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#showpars" target="_blank">showpars</a>`
-.. |typewalk| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#typewalk" target="_blank">typewalk</a>`
-.. |atfile| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>`
-.. |astrodatauser| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/release-{v}/" target="_blank">Astrodata User Manual</a>`
-
-.. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/">Recipe System Users Manual</a>`
-
-""".format(v = release)
+.. |caldb| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/caldb.html" target="_blank">caldb</a>`
+.. |dataselect| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#dataselect" target="_blank">dataselect</a>`
+.. |descriptors| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
+.. |descriptor| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
+.. |reduce| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/reduce.html" target="_blank">reduce</a>`
+.. |showd| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#showd" target"_blank">showd</a>`
+.. |showrecipes| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#showrecipes" target="_blank">showrecipes</a>`
+.. |showpars| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#showpars" target="_blank">showpars</a>`
+.. |typewalk| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#typewalk" target="_blank">typewalk</a>`
+.. |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-user-manual.readthedocs.io/en/{v}/" 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>`
+
+""".format(v = rtdurl)
diff --git a/geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py b/geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py
@@ -41,6 +41,8 @@
 # The full version, including alpha/beta/rc tags
 #release = astrodata.version()
 release = '3.0.0'
+rtdurl = 'v'+release
+#rtdurl = 'release-'+release
 
 
 # -- General configuration ---------------------------------------------------
@@ -243,21 +245,21 @@ def setup(app):
 .. role:: raw-html(raw)
    :format: html
 
-.. |caldb| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/caldb.html" target="_blank">caldb</a>`
-.. |dataselect| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#dataselect" target="_blank">dataselect</a>`
-.. |descriptors| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/release-{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
-.. |descriptor| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/release-{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
-.. |reduce| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/reduce.html" target="_blank">reduce</a>`
-.. |showd| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#showd" target"_blank">showd</a>`
-.. |showrecipes| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#showrecipes" target="_blank">showrecipes</a>`
-.. |showpars| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#showpars" target="_blank">showpars</a>`
-.. |typewalk| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html#typewalk" target="_blank">typewalk</a>`
-.. |atfile| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>`
-.. |astrodatauser| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/release-{v}/" target="_blank">Astrodata User Manual</a>`
+.. |caldb| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/caldb.html" target="_blank">caldb</a>`
+.. |dataselect| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#dataselect" target="_blank">dataselect</a>`
+.. |descriptors| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
+.. |descriptor| replace:: :raw-html:`<a href="https://astrodata-user-manual.readthedocs.io/en/{v}/appendices/appendix_descriptors.html" target="_blank">descriptors</a>`
+.. |reduce| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/reduce.html" target="_blank">reduce</a>`
+.. |showd| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#showd" target"_blank">showd</a>`
+.. |showrecipes| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#showrecipes" target="_blank">showrecipes</a>`
+.. |showpars| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#showpars" target="_blank">showpars</a>`
+.. |typewalk| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html#typewalk" target="_blank">typewalk</a>`
+.. |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-user-manual.readthedocs.io/en/{v}/" target="_blank">Astrodata User Manual</a>`
 
-.. |DRAGONS| replace:: :raw-html:`<a href="https://dragons.readthedocs.io/en/release-{v}/" target="_blank">DRAGONS</a>`
-.. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/">Recipe System Users Manual</a>`
+.. |DRAGONS| replace:: :raw-html:`<a href="https://dragons.readthedocs.io/en/{v}/" target="_blank">DRAGONS</a>`
+.. |RSUser|  replace:: :raw-html:`<a href="http://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/">Recipe System Users Manual</a>`
 
-.. |suptools| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-{v}/supptools.html" target="_blank">Supplemental Tools</a>`
+.. |suptools| replace:: :raw-html:`<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/{v}/supptools.html" target="_blank">Supplemental Tools</a>`
 
-""".format(v = release)
+""".format(v = rtdurl)