Skip to content
Snippets Groups Projects
Commit 2c51073a authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

convert glossary to rst, and open all external links in new page

parent 3b2d17de
No related branches found
No related tags found
1 merge request!80Feature/update documentation
*
import os
import sys
sys.path.insert(0, os.path.abspath(
os.path.join(
os.path.dirname(__file__),
'..', 'gso')))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'GÉANT Service Orchestrator' project = 'GÉANT Service Orchestrator'
copyright = '2023, GÉANT Vereniging' copyright = '2023, GÉANT Vereniging'
author = 'GÉANT Orchestration and Automation Team' author = 'GÉANT Orchestration and Automation Team'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
extensions = ['sphinx_rtd_theme', 'myst_parser', 'sphinx.ext.autodoc'] extensions = ['sphinx_rtd_theme', 'sphinx.ext.autodoc', 'sphinxcontrib.jquery']
templates_path = ['templates'] templates_path = ['templates']
exclude_patterns = ['build', 'Thumbs.db', '.DS_Store', 'venv', 'vale', '__init__.py'] exclude_patterns = ['build', 'Thumbs.db', '.DS_Store', 'venv', 'vale', '__init__.py']
source_suffix = {
'.md': 'markdown'
}
# -- Options for Markdown support --------------------------------------------
myst_enable_extensions = ['attrs_block', 'deflist', 'replacements', 'smartquotes', 'strikethrough', 'fieldlist']
suppress_warnings = ['myst.strikethrough']
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
...@@ -24,11 +25,11 @@ html_theme_options = { ...@@ -24,11 +25,11 @@ html_theme_options = {
'style_nav_header_background': 'rgb(0 63 95)', 'style_nav_header_background': 'rgb(0 63 95)',
} }
html_css_files = ['custom.css'] html_css_files = ['custom.css']
html_js_files = ['custom.js']
html_logo = 'static/geant_logo_white.svg' html_logo = 'static/geant_logo_white.svg'
# Both the class' and the __init__ method's docstring are concatenated and inserted. # Both the class' and the __init__ method's docstring are concatenated and inserted.
autoclass_content = 'both' autoclass_content = 'both'
# autodoc_typehints = 'none'
# Display todos by setting to True # Display todos by setting to True
todo_include_todos = True todo_include_todos = True
......
# Glossary of terms
{.glossary}
BGP
: Border Gateway Protocol: a path vector routing protocol described in
<a href="https://datatracker.ietf.org/doc/html/rfc4271" target="_blank">RFC 4271</a>.
CNAME
: A type of DNS record that is used as an alias from one hostname to another
CRUD
: Create, Read, Update, Delete
FQDN
: Fully Quantified Domain Name
GSO
: GÉANT Service Orchestrator
IPAM
: IP Address Management
IS-IS
: Intermediate System to Intermediate System: a routing protocol described in
<a href="https://datatracker.ietf.org/doc/html/rfc7142" target="_blank">RFC 7142</a>.
ISO
: International Organisation for Standardisation
LSO
: Lightweight Service Orchestrator
NET
: Network Entity Title: used for {term}`IS-IS` routing.
SNMP
: Simple Network Management Protocol: a protocol that's used for gathering data, widely used for network management and
monitoring.
WFO
: <a href="https://workfloworchestrator.org/" target="_blank">Workflow Orchestrator</a>
Glossary of terms
=================
.. glossary::
BGP
Border Gateway Protocol: a path vector routing protocol described in
`RFC 4271 <https://datatracker.ietf.org/doc/html/rfc4271>`_.
CNAME
A type of DNS record that is used as an alias from one hostname to another
CRUD
Create, Read, Update, Delete
FQDN
Fully Quantified Domain Name
GSO
GÉANT Service Orchestrator
IPAM
IP Address Management
IS-IS
Intermediate System to Intermediate System: a routing protocol described in
`RFC 7142 <https://datatracker.ietf.org/doc/html/rfc7142>`_.
ISO
International Organisation for Standardisation
LSO
Lightweight Service Orchestrator
NET
Network Entity Title: used for {term}`IS-IS` routing.
SNMP
Simple Network Management Protocol: a protocol that's used for gathering data, widely used for network management
and monitoring.
WFO
`Workflow Orchestrator <https://workfloworchestrator.org/>`_
$(document).ready(function () {
$('a.external').attr('target', '_blank');
});
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment