Trac #25786: Fix introspection with ? when doc source is not available

Currently, introspection does not work in [https://github.com/conda-
forge/sagelib-feedstock/issues/39 conda] and Arch Linux (if the
sagemath-doc package is not installed):
{{{
sage: ZZ?
…
/usr/lib/python2.7/site-packages/sage/misc/sagedoc.pyc in
process_extlinks(s, embedded)
    497     oldpath = sys.path
    498     sys.path = [os.path.join(SAGE_DOC_SRC, 'common')] + oldpath
--> 499     from conf import extlinks
    500     sys.path = oldpath
    501     for key in extlinks:

ImportError: cannot import name extlinks
}}}

The problem is that `src/doc/common/conf.py` is not in the place that
Sage expects.

I don't think that we should require the documentation configuration to
be installed for Sage to work.

A docker image to play with this is being built here:
https://gitlab.com/sagemath/dev/sage/pipelines/25262253

URL: https://trac.sagemath.org/25786
Reported by: saraedum
Ticket author(s): Julian Rüth, Isuru Fernando
Reviewer(s): Julian Rüth, Isuru Fernando, François Bissey

src/doc/ca/intro/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Introducció de Sage"

src/doc/de/a_tour_of_sage/conf.py

@@ -13,10 +13,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Ein Rundgang durch Sage"

src/doc/de/thematische_anleitungen/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Thematische Anleitungen"

src/doc/de/tutorial/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage Tutorial"

src/doc/en/a_tour_of_sage/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'A Tour of Sage'

src/doc/en/constructions/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage Constructions"

src/doc/en/developer/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage Developer's Guide"

src/doc/en/faq/conf.py

@@ -13,12 +13,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import os
-import sys
-
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *
 
 # General information about the project.
 project = u"Sage FAQ"

src/doc/en/installation/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage Installation Guide"

src/doc/en/prep/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 
 # General information about the project.

src/doc/en/reference/conf.py

@@ -11,10 +11,10 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
 from sage.env import SAGE_DOC_SRC, SAGE_DOC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, latex_elements, exclude_patterns
+from sage.docs.conf import *
 
 ref_src = os.path.join(SAGE_DOC_SRC, 'en', 'reference')
 ref_out = os.path.join(SAGE_DOC, 'html', 'en', 'reference')

src/doc/en/reference/conf_sub.py

@@ -11,10 +11,10 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
 from sage.env import SAGE_DOC_SRC, SAGE_DOC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, exclude_patterns
+from sage.docs.conf import *
 
 from six.moves import range
 

src/doc/en/thematic_tutorials/conf.py

@@ -13,11 +13,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import os
-import sys
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *
 
 # General information about the project.
 project = u"Thematic Tutorials"

src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 name = 'bordeaux_2008'

src/doc/en/thematic_tutorials/numerical_sage/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'Numerical Computing with Sage'

src/doc/en/tutorial/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage Tutorial"

src/doc/en/website/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'Sage Documentation'

src/doc/es/a_tour_of_sage/conf.py

@@ -13,11 +13,8 @@
 # All configuration values have a default; values that are commented
 # out serve to show the default.
 
-import sys
-import os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *
 
 # General information about the project.
 project = u'Un Tour Por Sage'

src/doc/es/tutorial/conf.py

@@ -11,11 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *
 
 # General information about the project.
 project = u"Sage Tutorial"

src/doc/fr/a_tour_of_sage/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, latex_elements
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'Sage en quelques mots'

src/doc/fr/tutorial/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, latex_elements
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Tutoriel Sage"

src/doc/hu/a_tour_of_sage/conf.py

@@ -13,10 +13,8 @@
 # All configuration values have a default; values that are commented
 # out serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'A Sage bemutatása'

src/doc/it/a_tour_of_sage/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, latex_elements
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'Esplora Sage'

src/doc/ja/a_tour_of_sage/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, latex_elements
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage ガイドツアー"

src/doc/ja/tutorial/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release, latex_elements
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Sage チュートリアル"

src/doc/pt/a_tour_of_sage/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u'Uma Turnê pelo Sage'

src/doc/pt/tutorial/conf.py

@@ -11,10 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from sage.env import SAGE_DOC_SRC
-sys.path.append(SAGE_DOC_SRC)
-from common.conf import *
+from sage.docs.conf import release
+from sage.docs.conf import *  # NOQA
 
 # General information about the project.
 project = u"Tutorial Sage"