diff --git a/docs/Makefile b/docs/Makefile index c8b5dff..b2058d5 100755 --- a/docs/Makefile +++ b/docs/Makefile @@ -19,7 +19,7 @@ HEADER = [Rest Watchdog] HOSTNAME = `hostname` # Dependencies for building documentation -DEPENDENCIES = Sphinx sphinxcontrib-napoleon sphinxcontrib-mockautodoc sphinx-rtd-theme +DEPENDENCIES = Sphinx==7.4.7 sphinxcontrib-napoleon sphinxcontrib-mockautodoc sphinx-rtd-theme==3.1.0 # User-friendly check for sphinx-build @@ -28,11 +28,11 @@ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in endif # Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +PAPEROPT_a4 = +PAPEROPT_letter = +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +I18NSPHINXOPTS = $(SPHINXOPTS) . .PHONY: distribute help clean docs html dirhtml singlehtml\ pickle json htmlhelp qthelp devhelp epub latex latexpdf text man\ diff --git a/docs/apidoc/rest.connector.libs.rst b/docs/apidoc/rest.connector.libs.rst index 9c89cc7..f823676 100644 --- a/docs/apidoc/rest.connector.libs.rst +++ b/docs/apidoc/rest.connector.libs.rst @@ -19,7 +19,7 @@ dnac :show-inheritance: iosxe -^^^^ +^^^^^ .. automodule:: rest.connector.libs.iosxe.implementation :members: :undoc-members: diff --git a/docs/changelog/2020/april.rst b/docs/changelog/2020/april.rst index 8d4c62e..679db35 100644 --- a/docs/changelog/2020/april.rst +++ b/docs/changelog/2020/april.rst @@ -7,7 +7,7 @@ April 28 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.4 | +| ``rest.connector`` | 20.4 | +-------------------------------+-------------------------------+ diff --git a/docs/changelog/2020/august.rst b/docs/changelog/2020/august.rst index 2d91ff5..8b174e8 100644 --- a/docs/changelog/2020/august.rst +++ b/docs/changelog/2020/august.rst @@ -1,18 +1,18 @@ August 2020 -========== +=========== August 25 --------- +--------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.8 | +| ``rest.connector`` | 20.8 | +-------------------------------+-------------------------------+ Features: ^^^^^^^^^ -* Fixed timeout issue in `connect()` +* Fixed timeout issue in ``connect()`` * Fixed issue with nxos _request() method when using expected_return_code diff --git a/docs/changelog/2020/december.rst b/docs/changelog/2020/december.rst index 52c4909..d4a40bd 100644 --- a/docs/changelog/2020/december.rst +++ b/docs/changelog/2020/december.rst @@ -7,7 +7,7 @@ December 15 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.12 | +| ``rest.connector`` | 20.12 | +-------------------------------+-------------------------------+ diff --git a/docs/changelog/2020/july.rst b/docs/changelog/2020/july.rst index d739a0b..95dd81f 100644 --- a/docs/changelog/2020/july.rst +++ b/docs/changelog/2020/july.rst @@ -7,7 +7,7 @@ July 28 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.7 | +| ``rest.connector`` | 20.7 | +-------------------------------+-------------------------------+ diff --git a/docs/changelog/2020/june.rst b/docs/changelog/2020/june.rst index 580be46..4a79dbf 100644 --- a/docs/changelog/2020/june.rst +++ b/docs/changelog/2020/june.rst @@ -7,7 +7,7 @@ July 7 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.6 | +| ``rest.connector`` | 20.6 | +-------------------------------+-------------------------------+ diff --git a/docs/changelog/2020/may.rst b/docs/changelog/2020/may.rst index 0c6b8fe..a75d877 100644 --- a/docs/changelog/2020/may.rst +++ b/docs/changelog/2020/may.rst @@ -7,7 +7,7 @@ May 26 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.5 | +| ``rest.connector`` | 20.5 | +-------------------------------+-------------------------------+ diff --git a/docs/changelog/2020/september.rst b/docs/changelog/2020/september.rst index 24f7b7d..c61d6f6 100644 --- a/docs/changelog/2020/september.rst +++ b/docs/changelog/2020/september.rst @@ -1,13 +1,13 @@ September 2020 -========== +============== September 29 --------- +------------ +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 20.9 | +| ``rest.connector`` | 20.9 | +-------------------------------+-------------------------------+ diff --git a/docs/changelog/2021/april.rst b/docs/changelog/2021/april.rst index e8f7af6..a813330 100644 --- a/docs/changelog/2021/april.rst +++ b/docs/changelog/2021/april.rst @@ -7,7 +7,7 @@ April 27 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.4 | +| ``rest.connector`` | 21.4 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/august.rst b/docs/changelog/2021/august.rst index b2de7fe..d3bb3c3 100644 --- a/docs/changelog/2021/august.rst +++ b/docs/changelog/2021/august.rst @@ -1,13 +1,13 @@ August 2021 -========= +=========== August 31 -------- +--------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.8 | +| ``rest.connector`` | 21.8 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/december.rst b/docs/changelog/2021/december.rst index ab47962..d11f004 100644 --- a/docs/changelog/2021/december.rst +++ b/docs/changelog/2021/december.rst @@ -1,15 +1,15 @@ December 2021 -========== +============= December 14 - Rest v21.12 ------------------------- +------------------------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.12 | +| ``rest.connector`` | 21.12 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/february.rst b/docs/changelog/2021/february.rst index b038ef8..b4f2626 100644 --- a/docs/changelog/2021/february.rst +++ b/docs/changelog/2021/february.rst @@ -1,13 +1,13 @@ February 2021 -============ +============= February 27 ----------- +----------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.2 | +| ``rest.connector`` | 21.2 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/january.rst b/docs/changelog/2021/january.rst index bec66a9..a3e8053 100644 --- a/docs/changelog/2021/january.rst +++ b/docs/changelog/2021/january.rst @@ -7,7 +7,7 @@ January 27 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.1 | +| ``rest.connector`` | 21.1 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/july.rst b/docs/changelog/2021/july.rst index e2ae40d..c1b1b18 100644 --- a/docs/changelog/2021/july.rst +++ b/docs/changelog/2021/july.rst @@ -7,7 +7,7 @@ July 27 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.7 | +| ``rest.connector`` | 21.7 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/june.rst b/docs/changelog/2021/june.rst index 19da4e6..e17e8cd 100644 --- a/docs/changelog/2021/june.rst +++ b/docs/changelog/2021/june.rst @@ -7,7 +7,7 @@ June 29 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.6 | +| ``rest.connector`` | 21.6 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/march.rst b/docs/changelog/2021/march.rst index 8aa6359..171119d 100644 --- a/docs/changelog/2021/march.rst +++ b/docs/changelog/2021/march.rst @@ -7,7 +7,7 @@ March 30 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.3 | +| ``rest.connector`` | 21.3 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/may.rst b/docs/changelog/2021/may.rst index b257e33..9c7c789 100644 --- a/docs/changelog/2021/may.rst +++ b/docs/changelog/2021/may.rst @@ -7,7 +7,7 @@ May 25 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.5 | +| ``rest.connector`` | 21.5 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2021/september.rst b/docs/changelog/2021/september.rst index c86af7b..8469b26 100644 --- a/docs/changelog/2021/september.rst +++ b/docs/changelog/2021/september.rst @@ -1,13 +1,13 @@ September 2021 -========= +============== September 28 -------- +------------ +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 21.9 | +| ``rest.connector`` | 21.9 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/april.rst b/docs/changelog/2022/april.rst index 5275875..24917fa 100644 --- a/docs/changelog/2022/april.rst +++ b/docs/changelog/2022/april.rst @@ -9,7 +9,7 @@ April 25 - Rest v22.4 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.4 | +| ``rest.connector`` | 22.4 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/august.rst b/docs/changelog/2022/august.rst index c8498e4..8d6949b 100644 --- a/docs/changelog/2022/august.rst +++ b/docs/changelog/2022/august.rst @@ -1,5 +1,5 @@ August 2022 -========== +=========== August 26 - Rest v22.8 ------------------------ @@ -9,7 +9,7 @@ August 26 - Rest v22.8 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.8 | +| ``rest.connector`` | 22.8 | +-------------------------------+-------------------------------+ Upgrade Instructions @@ -25,7 +25,7 @@ Upgrade Instructions Changelogs ^^^^^^^^^^ -------------------------------------------------------------------------------- - Fix +Fix -------------------------------------------------------------------------------- * nexus dashboard (nd) diff --git a/docs/changelog/2022/february.rst b/docs/changelog/2022/february.rst index 641db0d..ee6847f 100644 --- a/docs/changelog/2022/february.rst +++ b/docs/changelog/2022/february.rst @@ -9,7 +9,7 @@ February 24 - Rest v22.2 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.2 | +| ``rest.connector`` | 22.2 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/january.rst b/docs/changelog/2022/january.rst index 5dcf686..ac05796 100644 --- a/docs/changelog/2022/january.rst +++ b/docs/changelog/2022/january.rst @@ -1,5 +1,5 @@ January 2022 -========== +============ January 25 - Rest v22.1 ------------------------ @@ -9,7 +9,7 @@ January 25 - Rest v22.1 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.1 | +| ``rest.connector`` | 22.1 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/july.rst b/docs/changelog/2022/july.rst index b6f3105..62a0e36 100644 --- a/docs/changelog/2022/july.rst +++ b/docs/changelog/2022/july.rst @@ -9,7 +9,7 @@ July 26 - Rest v22.7 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.7 | +| ``rest.connector`` | 22.7 | +-------------------------------+-------------------------------+ Upgrade Instructions @@ -26,7 +26,7 @@ Features and Bug Fixes: ^^^^^^^^^^^^^^^^^^^^^^^ -------------------------------------------------------------------------------- - Fix +Fix -------------------------------------------------------------------------------- * Playback * Modified _mock_helper: diff --git a/docs/changelog/2022/june.rst b/docs/changelog/2022/june.rst index b373568..7288a5c 100644 --- a/docs/changelog/2022/june.rst +++ b/docs/changelog/2022/june.rst @@ -9,7 +9,7 @@ June 27 - Rest v22.6 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.6 | +| ``rest.connector`` | 22.6 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/march.rst b/docs/changelog/2022/march.rst index 2113119..65bf039 100644 --- a/docs/changelog/2022/march.rst +++ b/docs/changelog/2022/march.rst @@ -9,7 +9,7 @@ March 29 - Rest v22.3 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.3 | +| ``rest.connector`` | 22.3 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/may.rst b/docs/changelog/2022/may.rst index c0ce74f..272e6ba 100644 --- a/docs/changelog/2022/may.rst +++ b/docs/changelog/2022/may.rst @@ -9,7 +9,7 @@ May 30 - Rest v22.5 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.5 | +| ``rest.connector`` | 22.5 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/november.rst b/docs/changelog/2022/november.rst index fe442db..326280d 100644 --- a/docs/changelog/2022/november.rst +++ b/docs/changelog/2022/november.rst @@ -1,15 +1,15 @@ November 2022 -========== +============= November 28 - Rest v22.11 ------------------------- +------------------------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.11 | +| ``rest.connector`` | 22.11 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/october.rst b/docs/changelog/2022/october.rst index 770c3d9..23e60bf 100644 --- a/docs/changelog/2022/october.rst +++ b/docs/changelog/2022/october.rst @@ -1,5 +1,5 @@ October 2022 -========== +============ October 25 - Rest v22.10 ------------------------ @@ -9,7 +9,7 @@ October 25 - Rest v22.10 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.10 | +| ``rest.connector`` | 22.10 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2022/september.rst b/docs/changelog/2022/september.rst index 0ab95a5..8fe4638 100644 --- a/docs/changelog/2022/september.rst +++ b/docs/changelog/2022/september.rst @@ -1,15 +1,15 @@ September 2022 -========== +============== September 23 - Rest v22.9 ------------------------- +------------------------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 22.9 | +| ``rest.connector`` | 22.9 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/april.rst b/docs/changelog/2023/april.rst index 20e5015..b129178 100644 --- a/docs/changelog/2023/april.rst +++ b/docs/changelog/2023/april.rst @@ -9,7 +9,7 @@ April 25 - Rest v23.4 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.4 | +| ``rest.connector`` | 23.4 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/august.rst b/docs/changelog/2023/august.rst index ad64ac3..232faa5 100644 --- a/docs/changelog/2023/august.rst +++ b/docs/changelog/2023/august.rst @@ -1,5 +1,5 @@ August 2023 -========== +=========== August 29 - Rest v23.8 ------------------------ @@ -9,7 +9,7 @@ August 29 - Rest v23.8 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.8 | +| ``rest.connector`` | 23.8 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/february.rst b/docs/changelog/2023/february.rst index 80534b4..a38a508 100644 --- a/docs/changelog/2023/february.rst +++ b/docs/changelog/2023/february.rst @@ -1,5 +1,5 @@ February 2023 -========== +============= February 28 - Rest v23.2 ------------------------ @@ -9,7 +9,7 @@ February 28 - Rest v23.2 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.2 | +| ``rest.connector`` | 23.2 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/january.rst b/docs/changelog/2023/january.rst index 6e0cb4f..563d2ba 100644 --- a/docs/changelog/2023/january.rst +++ b/docs/changelog/2023/january.rst @@ -1,5 +1,5 @@ January 2023 -========== +============ January 31 - Rest v23.1 ------------------------ @@ -9,7 +9,7 @@ January 31 - Rest v23.1 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.1 | +| ``rest.connector`` | 23.1 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/july.rst b/docs/changelog/2023/july.rst index b60216b..94958a1 100644 --- a/docs/changelog/2023/july.rst +++ b/docs/changelog/2023/july.rst @@ -9,7 +9,7 @@ July 25 - Rest v23.7 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.7 | +| ``rest.connector`` | 23.7 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/june.rst b/docs/changelog/2023/june.rst index e70605d..48eb5a8 100644 --- a/docs/changelog/2023/june.rst +++ b/docs/changelog/2023/june.rst @@ -9,7 +9,7 @@ June 27 - Rest v23.6 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.6 | +| ``rest.connector`` | 23.6 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/march.rst b/docs/changelog/2023/march.rst index 2da00d0..44786f5 100644 --- a/docs/changelog/2023/march.rst +++ b/docs/changelog/2023/march.rst @@ -9,7 +9,7 @@ March 28 - Rest v23.3 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.3 | +| ``rest.connector`` | 23.3 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/may.rst b/docs/changelog/2023/may.rst index 29a6901..f4584be 100644 --- a/docs/changelog/2023/may.rst +++ b/docs/changelog/2023/may.rst @@ -9,7 +9,7 @@ May 30 - Rest v23.5 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.5 | +| ``rest.connector`` | 23.5 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/november.rst b/docs/changelog/2023/november.rst index 4b10f38..ffbed1c 100644 --- a/docs/changelog/2023/november.rst +++ b/docs/changelog/2023/november.rst @@ -1,15 +1,15 @@ November 2023 -========== +============= November 27 - Rest v23.11 ------------------------- +------------------------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.11 | +| ``rest.connector`` | 23.11 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/october.rst b/docs/changelog/2023/october.rst index c05956b..aae082e 100644 --- a/docs/changelog/2023/october.rst +++ b/docs/changelog/2023/october.rst @@ -1,5 +1,5 @@ October 2023 -========== +============ October 31 - Rest v23.10 ------------------------ @@ -9,7 +9,7 @@ October 31 - Rest v23.10 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.10 | +| ``rest.connector`` | 23.10 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2023/september.rst b/docs/changelog/2023/september.rst index d24962e..461b9e2 100644 --- a/docs/changelog/2023/september.rst +++ b/docs/changelog/2023/september.rst @@ -1,15 +1,15 @@ September 2023 -========== +============== September 26 - Rest v23.9 ------------------------- +------------------------- +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 23.9 | +| ``rest.connector`` | 23.9 | +-------------------------------+-------------------------------+ Upgrade Instructions @@ -25,7 +25,7 @@ Upgrade Instructions Changelogs ^^^^^^^^^^ -------------------------------------------------------------------------------- - Fix +Fix -------------------------------------------------------------------------------- * rest diff --git a/docs/changelog/2024/September.rst b/docs/changelog/2024/September.rst index 3f93877..c2a2a5b 100644 --- a/docs/changelog/2024/September.rst +++ b/docs/changelog/2024/September.rst @@ -1,8 +1,8 @@ September 2024 -========== +============== September 24 - Rest v24.9 ------------------------- +------------------------- diff --git a/docs/changelog/2024/april.rst b/docs/changelog/2024/april.rst index 36c72e9..6e8d7cf 100644 --- a/docs/changelog/2024/april.rst +++ b/docs/changelog/2024/april.rst @@ -1,7 +1,7 @@ April 2024 ========== - - Rest v24.4 +- Rest v24.4 ------------------------ @@ -9,7 +9,7 @@ April 2024 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.4 | +| ``rest.connector`` | 24.4 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/august.rst b/docs/changelog/2024/august.rst index 2c793db..b496676 100644 --- a/docs/changelog/2024/august.rst +++ b/docs/changelog/2024/august.rst @@ -1,5 +1,5 @@ August 2024 -========== +=========== August 27 - Rest v24.8 ------------------------ @@ -9,7 +9,7 @@ August 27 - Rest v24.8 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.8 | +| ``rest.connector`` | 24.8 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/february.rst b/docs/changelog/2024/february.rst index 694ac33..1476a68 100644 --- a/docs/changelog/2024/february.rst +++ b/docs/changelog/2024/february.rst @@ -1,5 +1,5 @@ February 2024 -========== +============= February 27 - Rest v24.2 ------------------------ @@ -9,7 +9,7 @@ February 27 - Rest v24.2 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.2 | +| ``rest.connector`` | 24.2 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/january.rst b/docs/changelog/2024/january.rst index c7a763a..ae0e5a9 100644 --- a/docs/changelog/2024/january.rst +++ b/docs/changelog/2024/january.rst @@ -1,5 +1,5 @@ January 2024 -========== +============ 30 - Rest v24.1 ------------------------ @@ -9,7 +9,7 @@ January 2024 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.1 | +| ``rest.connector`` | 24.1 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/july.rst b/docs/changelog/2024/july.rst index ec6b278..0220628 100644 --- a/docs/changelog/2024/july.rst +++ b/docs/changelog/2024/july.rst @@ -9,7 +9,7 @@ July 30 - Rest v24.7 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.7 | +| ``rest.connector`` | 24.7 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/june.rst b/docs/changelog/2024/june.rst index 61f71ea..a253ad6 100644 --- a/docs/changelog/2024/june.rst +++ b/docs/changelog/2024/june.rst @@ -1,7 +1,7 @@ June 2024 ========== - - Rest v24.6 +- Rest v24.6 ------------------------ @@ -9,7 +9,7 @@ June 2024 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.6 | +| ``rest.connector`` | 24.6 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/march.rst b/docs/changelog/2024/march.rst index f06cbe6..f02481b 100644 --- a/docs/changelog/2024/march.rst +++ b/docs/changelog/2024/march.rst @@ -1,7 +1,7 @@ March 2024 ========== - - Rest v24.3 +- Rest v24.3 ------------------------ @@ -9,7 +9,7 @@ March 2024 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.3 | +| ``rest.connector`` | 24.3 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/may.rst b/docs/changelog/2024/may.rst index 07ecd31..ae9d179 100644 --- a/docs/changelog/2024/may.rst +++ b/docs/changelog/2024/may.rst @@ -9,7 +9,7 @@ May 28 - Rest v24.5 +-------------------------------+-------------------------------+ | Module | Versions | +===============================+===============================+ -| ``rest.connector `` | 24.5 | +| ``rest.connector`` | 24.5 | +-------------------------------+-------------------------------+ Upgrade Instructions diff --git a/docs/changelog/2024/november.rst b/docs/changelog/2024/november.rst index eab097a..aba0dcf 100644 --- a/docs/changelog/2024/november.rst +++ b/docs/changelog/2024/november.rst @@ -1,8 +1,8 @@ November 2024 -========== +============= November 26 - Rest v24.11 ------------------------- +------------------------- @@ -17,7 +17,7 @@ November 26 - Rest v24.11 Changelogs ^^^^^^^^^^ -------------------------------------------------------------------------------- - New +New -------------------------------------------------------------------------------- * connector diff --git a/docs/changelog/2024/october.rst b/docs/changelog/2024/october.rst index 670d1a7..f8184df 100644 --- a/docs/changelog/2024/october.rst +++ b/docs/changelog/2024/october.rst @@ -1,5 +1,5 @@ October 2024 -========== +============ October 29 - Rest v24.10 ------------------------ diff --git a/docs/changelog/2025/april.rst b/docs/changelog/2025/april.rst index 1054d6f..0fa718d 100644 --- a/docs/changelog/2025/april.rst +++ b/docs/changelog/2025/april.rst @@ -17,7 +17,7 @@ April 29 - Rest v25.4 Changelogs ^^^^^^^^^^ -------------------------------------------------------------------------------- - New +New -------------------------------------------------------------------------------- * ise diff --git a/docs/changelog/2025/august.rst b/docs/changelog/2025/august.rst index c3e9852..3218ed6 100644 --- a/docs/changelog/2025/august.rst +++ b/docs/changelog/2025/august.rst @@ -1,5 +1,5 @@ August 2025 -========== +=========== August 23 - Rest v25.8 ------------------------ diff --git a/docs/changelog/2025/december.rst b/docs/changelog/2025/december.rst index b4f9859..53dd554 100644 --- a/docs/changelog/2025/december.rst +++ b/docs/changelog/2025/december.rst @@ -1,8 +1,8 @@ December 2025 -========== +============= December 30 - Rest v25.11 ------------------------- +------------------------- diff --git a/docs/changelog/2025/february.rst b/docs/changelog/2025/february.rst index 59b92f6..e491e25 100644 --- a/docs/changelog/2025/february.rst +++ b/docs/changelog/2025/february.rst @@ -1,5 +1,5 @@ February 2025 -========== +============= February 25 - Rest v25.2 ------------------------ diff --git a/docs/changelog/2025/january.rst b/docs/changelog/2025/january.rst index 2d9eec8..aedc506 100644 --- a/docs/changelog/2025/january.rst +++ b/docs/changelog/2025/january.rst @@ -1,7 +1,7 @@ January 2025 -========== +============ - - Rest v25.1 +- Rest v25.1 ------------------------ @@ -17,7 +17,7 @@ January 2025 Changelogs ^^^^^^^^^^ -------------------------------------------------------------------------------- - Fix +Fix -------------------------------------------------------------------------------- * connector diff --git a/docs/changelog/2025/may.rst b/docs/changelog/2025/may.rst index 6c530bd..f3a1d5f 100644 --- a/docs/changelog/2025/may.rst +++ b/docs/changelog/2025/may.rst @@ -1,7 +1,7 @@ May 2025 ========== - - Rest v25.5 +- Rest v25.5 ------------------------ diff --git a/docs/changelog/2025/october.rst b/docs/changelog/2025/october.rst index c389f35..18d7c2b 100644 --- a/docs/changelog/2025/october.rst +++ b/docs/changelog/2025/october.rst @@ -1,5 +1,5 @@ October 2025 -========== +============ October 28 - Rest v25.10 ------------------------ diff --git a/docs/changelog/2025/september.rst b/docs/changelog/2025/september.rst index 2fd172a..c09e45b 100644 --- a/docs/changelog/2025/september.rst +++ b/docs/changelog/2025/september.rst @@ -1,8 +1,8 @@ September 2025 -========== +============== September 30 - Rest v25.9 ------------------------- +------------------------- @@ -17,7 +17,7 @@ September 30 - Rest v25.9 Changelogs ^^^^^^^^^^ -------------------------------------------------------------------------------- - Fix +Fix -------------------------------------------------------------------------------- * iosxe diff --git a/docs/changelog/2026/april.rst b/docs/changelog/2026/april.rst new file mode 100644 index 0000000..073364b --- /dev/null +++ b/docs/changelog/2026/april.rst @@ -0,0 +1,19 @@ +April 2026 +========== + +April 28 - Rest v26.4 +--------------------- + + + +.. csv-table:: New Module Versions + :header: "Modules", "Version" + + ``rest.connector``, v26.4 + + + + +Changelogs +^^^^^^^^^^ + diff --git a/docs/changelog/2026/february.rst b/docs/changelog/2026/february.rst index b039f5a..4a903e7 100644 --- a/docs/changelog/2026/february.rst +++ b/docs/changelog/2026/february.rst @@ -1,5 +1,5 @@ February 2026 -========== +============= February 24 - Rest v26.2 ------------------------ diff --git a/docs/changelog/2026/january.rst b/docs/changelog/2026/january.rst index e60e83e..1c72ce7 100644 --- a/docs/changelog/2026/january.rst +++ b/docs/changelog/2026/january.rst @@ -1,5 +1,5 @@ January 2026 -========== +============ January 26 - Rest v26.1 ------------------------ diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst index 06813ae..411fb38 100644 --- a/docs/changelog/index.rst +++ b/docs/changelog/index.rst @@ -4,6 +4,7 @@ Changelog .. toctree:: :maxdepth: 2 + 2026/april 2026/march 2026/february 2026/january @@ -52,7 +53,6 @@ Changelog 2022/february 2022/january 2021/december - 2021/october 2021/september 2021/august 2021/july @@ -62,6 +62,7 @@ Changelog 2021/march 2021/february 2021/january + 2020/december 2020/october 2020/september 2020/august diff --git a/docs/changelog/undistributed/template.rst b/docs/changelog/undistributed/template.rst index c4bda3e..ca04a9f 100644 --- a/docs/changelog/undistributed/template.rst +++ b/docs/changelog/undistributed/template.rst @@ -4,14 +4,14 @@ Templates ========= -------------------------------------------------------------------------------- - New +New -------------------------------------------------------------------------------- * * : * -------------------------------------------------------------------------------- - Fix +Fix -------------------------------------------------------------------------------- * * : @@ -21,7 +21,7 @@ Examples ======== -------------------------------------------------------------------------------- - New +New -------------------------------------------------------------------------------- * feature * Modified Connect: diff --git a/docs/conf.py b/docs/conf.py index 181e6ee..e342c6e 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -74,7 +74,8 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', 'changelog/undistributed.rst', 'changelog/undistributed/*'] +suppress_warnings = ['docutils', 'ref.python'] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/docs/user_guide/introduction.rst b/docs/user_guide/introduction.rst index 9b30b04..22db8ca 100644 --- a/docs/user_guide/introduction.rst +++ b/docs/user_guide/introduction.rst @@ -33,7 +33,7 @@ Example use ----------- -To specify a ``Rest`` connection for your device, add the ``rest.connector.Rest`` class +To specify a ``Rest``connection for your device, add the``rest.connector.Rest`` class to the connection for your devices in the testbed YAML file: .. code-block:: yaml diff --git a/docs/user_guide/services/index.rst b/docs/user_guide/services/index.rst index d63fe1d..49e56a7 100644 --- a/docs/user_guide/services/index.rst +++ b/docs/user_guide/services/index.rst @@ -17,3 +17,5 @@ This part of the document covers all the services supported by rest.connector. viptela dcnm nd + elasticsearch + webex diff --git a/docs/user_guide/services/nd.rst b/docs/user_guide/services/nd.rst index 1c4d342..f598bbc 100644 --- a/docs/user_guide/services/nd.rst +++ b/docs/user_guide/services/nd.rst @@ -1,5 +1,5 @@ Nexus Dashboard (ND) -==== +==================== The following services are supported by the REST connector for Nexus Dashboard (ND). diff --git a/setup.py b/setup.py index 7c6e323..0267c6a 100755 --- a/setup.py +++ b/setup.py @@ -167,8 +167,8 @@ def find_version(*paths): extras_require={ 'dev': ['coverage', 'restview', - 'Sphinx', - 'sphinx-rtd-theme', + 'Sphinx==7.4.7', + 'sphinx-rtd-theme==3.1.0', 'requests-mock'], }, diff --git a/src/rest/connector/__init__.py b/src/rest/connector/__init__.py index c4fd6ed..5391f4e 100644 --- a/src/rest/connector/__init__.py +++ b/src/rest/connector/__init__.py @@ -2,7 +2,7 @@ the device via REST api""" # metadata -__version__ = "26.3" +__version__ = "26.4" __author__ = ['Jean-Benoit Aubin ', 'Takashi Higashimura (tahigash) ']