Disable sphinx.ext.viewcode

Generates a broken link that causes linkchecker to fail.
This is a useful extension that will help especially for navigating
from the infrastructure documentation to source files (where navigable
content is more important than user-facing polish) but we aren't ready
for it right now.

Change-Id: I1a8c18428fac532c6064ea583c3b6952bd2e821e

diff --git a/docs/conf.cmakein.py b/docs/conf.cmakein.py
index 1435ca63afa9d2c81188e47ff22cdcc1c7e24032..834428d8491cf7cff9ef214e6be8a98d183d7a82 100644 (file)
--- a/docs/conf.cmakein.py
+++ b/docs/conf.cmakein.py
@@ -110,7 +110,14 @@ extensions = [
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
+    # The viewcode extension requires extra configuration or consideration to
+    # avoid collecting sources for external packages (through intersphninx) or
+    # generating broken links for compiled extension modules that do not have
+    # inspectable 'code' member data.
+    # Ref: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
+    # Please run linkchecker and inspect the generated
+    # docs/html/_modules/index.html page before committing a change that enables
+    # 'sphinx.ext.viewcode',
     'gmxsphinx'
 ]
 extlinks = {'issue': ('https://redmine.gromacs.org/issues/%s',