summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDonald Sharp <sharpd@cumulusnetworks.com>2020-08-27 07:17:17 -0400
committerGitHub <noreply@github.com>2020-08-27 07:17:17 -0400
commit1944de61f773f7f9780c6b842ca147cf58ab422c (patch)
treed522fa2069f321d960511ab2aad70ab0ab8e1450
parent2f826685a7f90a47e71d6cbe45240ceeadfa9562 (diff)
parent3b79e573785ff5c86b08bc06344e9c52a751078c (diff)
Merge pull request #7002 from mjstapp/fix_doc_sphinx_api
doc: test sphinx version, use correct apis
-rw-r--r--doc/user/conf.py27
1 files changed, 25 insertions, 2 deletions
diff --git a/doc/user/conf.py b/doc/user/conf.py
index d8a188b152..1f6f050bcf 100644
--- a/doc/user/conf.py
+++ b/doc/user/conf.py
@@ -16,6 +16,7 @@ import sys
import os
import re
import pygments
+import sphinx
from sphinx.highlighting import lexers
# If extensions (or modules to document with autodoc) are in another directory,
@@ -359,14 +360,36 @@ texinfo_documents = [
with open('../extra/frrlexer.py', 'rb') as lex:
frrlexerpy = lex.read()
+# Parse version string into int array
+def vparse(s):
+ a = []
+
+ for c in s:
+ if c != '.':
+ a.append(int(c))
+
+ while len(a) < 3:
+ a.append(0)
+
+ return a[:3]
+
# custom extensions here
def setup(app):
# object type for FRR CLI commands, can be extended to document parent CLI
# node later on
app.add_object_type('clicmd', 'clicmd')
+
# css overrides for HTML theme
- app.add_stylesheet('overrides.css')
- app.add_javascript('overrides.js')
+ # Note sphinx version differences
+ sver = vparse(sphinx.__version__)
+
+ if sver < vparse('1.8.0') :
+ app.add_stylesheet('overrides.css')
+ app.add_javascript('overrides.js')
+ else:
+ app.add_css_file('overrides.css')
+ app.add_js_file('overrides.js')
+
# load Pygments lexer for FRR config syntax
#
# NB: in Pygments 2.2+ this can be done with `load_lexer_from_file`, but we