Update Sphinx
- Bump versions in requirements.txt
Remove sphinx docs which were duplicated everywhere, refer to ONF main
docs site which is more complete.
Replace logo with SVG version
- Was a WebP saved as .png which broke in some browsers.
- Shift logo to sidebar, as in all other docs sites.
Cleanup Makefile
Change how the dict.txt sorter works
- Only check the dict.txt for changes
- Give human-intelligible results
Add correct licensing info for fonts
Add code of conduct and link
Change-Id: Ie4334cfea826e348eca4c93ed62a3633b33ad87c
diff --git a/conf.py b/conf.py
index e949e7a..a124a7b 100644
--- a/conf.py
+++ b/conf.py
@@ -100,13 +100,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.
@@ -119,17 +119,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,
@@ -259,13 +255,12 @@
# -- 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),
- 'aether': ('https://docs.aetherproject.org/master', None),
}
def setup(app):