doc: cleanup the structure a bit

Signed-off-by: Christian Hopps <[email protected]>
FRRouting · Jan 27, 2024 · cdfff3e · cdfff3e
1 parent e2a9eb9
commit cdfff3e
Show file tree

Hide file tree

Showing 13 changed files with 64 additions and 57 deletions.
diff --git a/doc/developer/northbound/advanced-topics.rst b/doc/developer/northbound/advanced-topics.rst
@@ -1,3 +1,11 @@
+Advanced Topics
+===============
+
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 1
+
 Auto-generated CLI commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/doc/developer/northbound/architecture.rst b/doc/developer/northbound/architecture.rst
@@ -1,3 +1,6 @@
+Architecture
+============
+
 Introduction
 ------------
 

diff --git a/doc/developer/northbound/demos.rst b/doc/developer/northbound/demos.rst
@@ -1,3 +1,6 @@
+Demos
+=====
+
 Transactional CLI
 -----------------
 

diff --git a/doc/developer/northbound/links.rst b/doc/developer/northbound/links.rst
@@ -1,3 +1,6 @@
+Links
+=====
+
 RFCs
 ~~~~
 

diff --git a/doc/developer/northbound/northbound.rst b/doc/developer/northbound/northbound.rst
@@ -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
diff --git a/doc/developer/northbound/operational-data-rpcs-and-notifications.rst b/doc/developer/northbound/operational-data-rpcs-and-notifications.rst
@@ -1,3 +1,11 @@
+Operational Data, RPCs and Notifications
+========================================
+
+.. contents:: Table of contents
+    :local:
+    :backlinks: entry
+    :depth: 1
+
 Operational data
 ~~~~~~~~~~~~~~~~
 

diff --git a/doc/developer/northbound/plugins-sysrepo.rst b/doc/developer/northbound/plugins-sysrepo.rst
@@ -1,3 +1,6 @@
+Plugins Sysrepo (old)
+=====================
+
 Installation
 ------------
 

diff --git a/doc/developer/northbound/ppr-basic-test-topology.rst b/doc/developer/northbound/ppr-basic-test-topology.rst
@@ -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
 ~~~~~~~~

diff --git a/doc/developer/northbound/ppr-mpls-basic-test-topology.rst b/doc/developer/northbound/ppr-mpls-basic-test-topology.rst
@@ -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
 ~~~~~~~~

diff --git a/doc/developer/northbound/retrofitting-configuration-commands.rst b/doc/developer/northbound/retrofitting-configuration-commands.rst
@@ -2,17 +2,22 @@
 .. _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
 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/doc/developer/northbound/transactional-cli.rst b/doc/developer/northbound/transactional-cli.rst
@@ -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
 ~~~~~~~~~~~~

diff --git a/doc/developer/northbound/yang-module-translator.rst b/doc/developer/northbound/yang-module-translator.rst
@@ -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
 ------------

diff --git a/doc/developer/northbound/yang-tools.rst b/doc/developer/northbound/yang-tools.rst
@@ -1,5 +1,5 @@
 Yang Tools
-~~~~~~~~~~
+==========
 
 Here's some information about various tools for working with yang
 models.
-Original file line number
+Diff line change
@@ -1,3 +1,6 @@
+    Demos
+    =====
     Transactional CLI
     -----------------
@@ Expand Down @@