Fix sdfabric-1.0 branch build
Change-Id: Ia79016809debe3b8b9f8f226dd4d8896d07dcffe
diff --git a/conf.py b/conf.py
index 3866491..97242aa 100644
--- a/conf.py
+++ b/conf.py
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2021 Open Networking Foundation <info@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
@@ -71,6 +74,10 @@
# include only the branches matching master and sdfabric-*
smv_branch_whitelist = r'^(master|sdfabric-.*)$'
+# Don't include any tags - smv docs say you can put None here, but that is broken
+# https://github.com/Holzhaus/sphinx-multiversion/issues/47
+smv_tag_whitelist = r'notags'
+
# include all remote branches
smv_remote_whitelist = r'^.*$'
@@ -97,13 +104,13 @@
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
- '*/LICENSE.md',
- '*/vendor',
'.DS_Store',
+ 'LICENSE',
+ 'README',
'Thumbs.db',
'_build',
- 'venv-docs',
'requirements.txt',
+ 'venv-docs',
]
# The name of the Pygments (syntax highlighting) style to use.
@@ -116,17 +123,13 @@
#
html_theme = 'sphinx_rtd_theme'
-# html_logo = '_static/sdfabric.svg'
+html_logo = '_static/sdfabric-logo.svg'
html_favicon = '_static/sdfabric-favicon-128.png'
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {
-# 'logo_only': True
-# }
+html_theme_options = {
+ 'logo_only': True
+}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -243,10 +246,6 @@
# -- Options for linkcheck ---------------------------------------------------
# The link checker strips off .md from links and then complains
linkcheck_ignore = [
- r'https://github.com/stratum/fabric-tna/*', # Fabric-TNA private repo
- r'https://github.com/opennetworkinglab/sdfabric-utils', # Private repo
- r'https://github.com/omec-project/up4/*', # UP4 private repo
- r'https://github.com/omec-project/dbuf/*', # DBUF private repo
r'https://jenkins.aetherproject.org/view/SD-Fabric%20Nightly%20Tests/' # Jenkins View, requires login
]
@@ -260,13 +259,14 @@
# -- options for Intersphinx extension ---------------------------------------
intersphinx_mapping = {
- 'ansible': ('https://docs.ansible.com/ansible/latest', None),
'sphinx': ('https://www.sphinx-doc.org/en/master', None),
'trellis': ('https://docs.trellisfabric.org/master', None),
+ 'aether': ('https://docs.aetherproject.org/master', None),
+ 'onf': ('https://docs.opennetworking.org/', None),
'sysapproach5g': ('https://5g.systemsapproach.org/', None),
'sysapproachnet': ('https://book.systemsapproach.org/', None),
'sysapproachsdn': ('https://sdn.systemsapproach.org/', None),
- }
+}
def setup(app):