1.2. Añadir contenido al Árbol TOC

Nota

Recuerde cambiar el path de sus comandos basado en si usó cd o otro path de proyecto

Probablemente quiera empezar a escribir documentación y organizar su sitio, creando un directorio llamado docs dentro de su proyecto

mkdir docs

Luego querrá añadir los índices para cada sección (los cuales se referencian por separado) o el directorio entero (lo cuál significa que cada sección y sub-sección estará separada).

Aquí hay un ejemplo de una tabla de contenidos para este sitio

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
.. toctree::
    :glob:
    :numbered:
    :maxdepth: 2

    docs/Auto-loader/00*
    docs/DRBD9.x/00*
    docs/Proxmox VE/00*
    docs/Samba DNS/00*
    docs/Samba Share/00*
    docs/Ubuntu Server/00*
    docs/ZABBIX/00*

Tendrá que incluir cualquier sub-directorio que quiera tener en el TOC a un índice que lo referencie.

Ya que quiero que el sitio sea prolijo decidí usar un include en el índice para cada sub-sección (ej.: Proxmox) para que todo el contenido esté en una sola página.

Aquí yace un Ejemplo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.. ubuntu index file for organization

.. highlight:: shell

*********
Ubuntu Server
*********

Documentation on Ubuntu Server Tweaks and Tricks for more optimized configurations.

.. include:: ./01-ubu-revert-netplan.rst
.. include:: ./03-ubu-join-ad.rst
.. include:: ./04-ubu-legacy-eth.rst
.. include:: ./05-ubu-lvm-extend.rst

**********
Cloud-Init (Ubuntu)
**********

For Cloud-Init specific issues.

.. include:: ./02-ubu-cinit-hostname-force.rst
.. include:: ./06-ubu-cinit-setup.rst