]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: cleanup the structure a bit 15242/head
authorChristian Hopps <chopps@labn.net>
Sat, 27 Jan 2024 10:03:57 +0000 (05:03 -0500)
committerChristian Hopps <chopps@labn.net>
Sat, 27 Jan 2024 10:03:57 +0000 (05:03 -0500)
Signed-off-by: Christian Hopps <chopps@labn.net>
13 files changed:
doc/developer/northbound/advanced-topics.rst
doc/developer/northbound/architecture.rst
doc/developer/northbound/demos.rst
doc/developer/northbound/links.rst
doc/developer/northbound/northbound.rst
doc/developer/northbound/operational-data-rpcs-and-notifications.rst
doc/developer/northbound/plugins-sysrepo.rst
doc/developer/northbound/ppr-basic-test-topology.rst
doc/developer/northbound/ppr-mpls-basic-test-topology.rst
doc/developer/northbound/retrofitting-configuration-commands.rst
doc/developer/northbound/transactional-cli.rst
doc/developer/northbound/yang-module-translator.rst
doc/developer/northbound/yang-tools.rst

index 92f800c4a5d5e8eee069bf73c6c47c1cea775c0d..edfc10bcbd3211342d27fafaa07955dfa9a9b157 100644 (file)
@@ -1,3 +1,11 @@
+Advanced Topics
+===============
+
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 1
+
 Auto-generated CLI commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
index 06e58843ac6b418640491da3fcf69797d7b576d6..5fd89c32f19059ab001d7bc4933fbb57d6a2f543 100644 (file)
@@ -1,3 +1,6 @@
+Architecture
+============
+
 Introduction
 ------------
 
index 876bd2522236eeb3f33a3fffe9b03add2d3bcdf3..8a0f6ad6b252841ee2cad446a2a2d8936e879274 100644 (file)
@@ -1,3 +1,6 @@
+Demos
+=====
+
 Transactional CLI
 -----------------
 
index e80374c57b15e0eae76bb7f47ecbe325efb101e6..6cec176f8b6d4b946f8cbf0ebf16c88af4486342 100644 (file)
@@ -1,3 +1,6 @@
+Links
+=====
+
 RFCs
 ~~~~
 
index 7dddf06460398bdd9fe8123531795293a9a7333e..c5f4e2f7e671cd866b7652997d2002bc1327f973 100644 (file)
@@ -11,11 +11,11 @@ Northbound API
    transactional-cli
    retrofitting-configuration-commands
    operational-data-rpcs-and-notifications
-   plugins-sysrepo
    advanced-topics
    yang-tools
    yang-module-translator
    demos
    links
+   plugins-sysrepo
    ppr-basic-test-topology
    ppr-mpls-basic-test-topology
index 500dd8ea2e39774244bed94280ec04eb9ed9a7c8..5cb70ca6f169667dd10bd49d469294af07fbfd6a 100644 (file)
@@ -1,3 +1,11 @@
+Operational Data, RPCs and Notifications
+========================================
+
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 1
+
 Operational data
 ~~~~~~~~~~~~~~~~
 
index 186c3a0177d143fa435661f2a640f40b530e9611..17971575737598f129581d306d4415f4b8f63c2e 100644 (file)
@@ -1,3 +1,6 @@
+Plugins Sysrepo (old)
+=====================
+
 Installation
 ------------
 
index a680ed7dfa84e5ce33e36b3c85eec6bea138e438..4929c9b2857004f05c769365ff5d97b36db2c869 100644 (file)
@@ -1,15 +1,10 @@
-Table of Contents
-~~~~~~~~~~~~~~~~~
+IS-IS PPR Basic
+===============
 
--  `Software <#software>`__
--  `Topology <#topology>`__
--  `Configuration <#configuration>`__
-
-   -  `CLI <#configuration-cli>`__
-   -  `YANG <#configuration-yang>`__
-
--  `Verification - Control Plane <#verification-cplane>`__
--  `Verification - Forwarding Plane <#verification-fplane>`__
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 2
 
 Software
 ~~~~~~~~
index cedb795da997c852da9332121fc030c7fe15ed1a..aceec5fa2f8a5a734ece68126ecf3718c1fb827d 100644 (file)
@@ -1,15 +1,10 @@
-Table of Contents
-~~~~~~~~~~~~~~~~~
+IS-IS PPR Basic MPLS
+====================
 
--  `Software <#software>`__
--  `Topology <#topology>`__
--  `Configuration <#configuration>`__
-
-   -  `CLI <#configuration-cli>`__
-   -  `YANG <#configuration-yang>`__
-
--  `Verification - Control Plane <#verification-cplane>`__
--  `Verification - Forwarding Plane <#verification-fplane>`__
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 2
 
 Software
 ~~~~~~~~
index bd417eb3ee419251ddb7d9c2fa328c9510bc5227..47726108568f6f0f257f99f5129f3429118a8aae 100644 (file)
@@ -2,7 +2,15 @@
 .. _nb-retrofit:
 
 Retrofitting Configuration Commands
------------------------------------
+===================================
+
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 2
+
+Retrofitting process
+--------------------
 
 This page explains how to convert existing CLI configuration commands to
 the new northbound model. This documentation is meant to be the primary
@@ -10,9 +18,6 @@ reference for developers working on the northbound retrofitting process.
 We’ll show several examples taken from the ripd northbound conversion to
 illustrate some concepts described herein.
 
-Retrofitting process
---------------------
-
 Step 1: writing a YANG module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
index a96ecfa1c10f24e8f010f6a222ddde6329b229a5..5c495d3a89dbcd7f56c59c0020c4590e328ae258 100644 (file)
@@ -1,25 +1,10 @@
-Table of Contents
------------------
-
--  `Introduction <#introduction>`__
--  `Configuration modes <#config-modes>`__
--  `New commands <#retrofitting-process>`__
-
-   -  `commit check <#cmd1>`__
-   -  `commit <#cmd2>`__
-   -  `discard <#cmd3>`__
-   -  `configuration database max-transactions <#cmd4>`__
-   -  `configuration load <#cmd5>`__
-   -  `rollback configuration <#cmd6>`__
-   -  `show configuration candidate <#cmd7>`__
-   -  `show configuration compare <#cmd8>`__
-   -  `show configuration running <#cmd9>`__
-   -  `show configuration transaction <#cmd10>`__
-   -  `show yang module <#cmd11>`__
-   -  `show yang module-translator <#cmd12>`__
-   -  `update <#cmd13>`__
-   -  `yang module-translator load <#cmd14>`__
-   -  `yang module-translator unload <#cmd15>`__
+Transactional CLI
+=================
+
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 1
 
 Introduction
 ~~~~~~~~~~~~
index e710100d0a97ce7c8545b552a5a239998605d15e..17ae160f079b6191d6c44a8511eeaabc2ebddb0e 100644 (file)
@@ -1,11 +1,10 @@
-Table of Contents
------------------
+YANG Module Translation
+=======================
 
--  `Introduction <#introduction>`__
--  `Deviation Modules <#deviation-modules>`__
--  `Translation Tables <#translation-tables>`__
--  `CLI Demonstration <#cli-demonstration>`__
--  `Implementation Details <#implementation-details>`__
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 1
 
 Introduction
 ------------
index 2d27d37bb3b4528cffdf1857987b88af934c150c..fb5a2872457b894343b99216f2447c8cbc14b66b 100644 (file)
@@ -1,5 +1,5 @@
 Yang Tools
-~~~~~~~~~~
+==========
 
 Here's some information about various tools for working with yang
 models.