Skip to content
Snippets Groups Projects
Commit 3fe41c67 authored by Hakan Calim's avatar Hakan Calim
Browse files

NAT-286: merged from develop

parents f0774e61 af39ed7c
No related branches found
No related tags found
1 merge request!89Feature/nat 286 create unit tests for netbox client
Pipeline #84241 failed
Showing
with 208 additions and 55 deletions
......@@ -2,3 +2,4 @@ include gso/migrations/*.py
include gso/migrations/*.mako
include gso/migrations/versions/*.py
include gso/translations/*.json
include gso/alembic.ini
pip install sphinx_rtd_theme myst-parser
pip install sphinx_rtd_theme sphinxcontrib-jquery
cd docs || exit 1
sphinx-build source build
......@@ -7,7 +7,7 @@ build-documentation:
image: sphinxdoc/sphinx:latest
before_script:
- pip install sphinx_rtd_theme sphinx-autodoc2 myst-parser
- pip install sphinx_rtd_theme sphinxcontrib-jquery
- cd $CI_PROJECT_DIR/docs/source
script:
- make html
......
*
......@@ -4,18 +4,10 @@ copyright = '2023, GÉANT Vereniging'
author = 'GÉANT Orchestration and Automation Team'
# -- General configuration ---------------------------------------------------
extensions = ['sphinx_rtd_theme', 'myst_parser', 'sphinx.ext.autodoc']
extensions = ['sphinx_rtd_theme', 'sphinx.ext.autodoc', 'sphinxcontrib.jquery']
templates_path = ['templates']
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 -------------------------------------------------
html_theme = 'sphinx_rtd_theme'
......@@ -24,11 +16,12 @@ html_theme_options = {
'style_nav_header_background': 'rgb(0 63 95)',
}
html_css_files = ['custom.css']
html_js_files = ['custom.js']
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'
# autodoc_typehints = 'none'
autodoc_typehints = 'none'
# Display todos by setting to 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>`_.
CIDR
Classless Inter-Domain Routing. A method for denoting IP ranges in the form of ``9.9.0.0/16`` or
``fe80:1234:abcd::/48``.
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
LAG
Link Aggregation: a bundle of multiple network connections.
LSO
Lightweight Service Orchestrator
NET
Network Entity Title: used for :term:`IS-IS` routing.
OSS
Operational Support Systems
SNMP
Simple Network Management Protocol: a protocol that's used for gathering data, widely used for network management
and monitoring.
UUID
Universally Unique Identifier
WFO
`Workflow Orchestrator <https://workfloworchestrator.org/>`_
# GÉANT Service Orchestrator ({term}`GSO`)
GÉANT Service Orchestrator
==========================
Welcome to the documentation of the GÉANT Service Orchestrator, or {term}`GSO` for short.
Welcome to the documentation of the GÉANT Service Orchestrator, or :term:`GSO` for short.
This documentation has the following sections:
```{toctree}
:caption: Contents
:maxdepth: 1
quickstart.md
apidocs/gso/gso
glossary.md
```
.. toctree::
:caption: Contents
:maxdepth: 2
quickstart
modules
glossary
``gso.api``
===========
.. automodule:: gso.api
:members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 2
:titlesonly:
v1/index
``gso.api.v1.imports``
======================
.. automodule:: gso.api.v1.imports
:members:
:show-inheritance:
``gso.api.v1``
==============
.. automodule:: gso.api.v1
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
imports
``gso.cli.import_sites``
========================
.. automodule:: gso.cli.import_sites
:members:
:show-inheritance:
``gso.cli``
===========
.. automodule:: gso.cli
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
import_sites
netbox
``gso.cli.netbox``
==================
.. automodule:: gso.cli.netbox
:members:
:show-inheritance:
``gso.products``
================
Subpackages
-----------
.. toctree::
:maxdepth: 1
product_blocks/index
product_types/index
Submodules
----------
``gso.products.shared`` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gso.products.shared
:members:
:show-inheritance:
``gso.products.product_blocks``
===============================
``gso.products.product_blocks`` package
---------------------------------------
.. automodule:: gso.products.product_blocks
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 1
iptrunk
router
site
``gso.products.product_blocks.iptrunk``
=======================================
.. automodule:: gso.products.product_blocks.iptrunk
:members:
:show-inheritance:
``gso.products.product_blocks.router``
======================================
.. automodule:: gso.products.product_blocks.router
:members:
:show-inheritance:
``gso.products.product_blocks.site``
====================================
.. automodule:: gso.products.product_blocks.site
:members:
:show-inheritance:
``gso.products.product_types``
==============================
``gso.products.product_types`` package
--------------------------------------
.. automodule:: gso.products.product_types
:members:
:show-inheritance:
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