docs/index.rst

   1
   2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 .. SPDX-License-Identifier: CC-BY-4.0
   4
   5
   6 .. who in bloody hell knows what format this should be; guessing!
   7 .. it does seem though that every .rst file in the directory must be listed here
   8 .. or tox will complain and fail.
   9
  10
  11 RIC xAPP C++ Framework
  12 ======================
  13
  14 .. toctree::
  15    :maxdepth: 1
  16    :caption: Documents:
  17    :titlesonly:
  18
  19    user-guide.rst
  20
  21 .. toctree::
  22    :maxdepth: 1
  23    :caption: Misc:
  24    :titlesonly:
  25
  26    rel-notes.rst
  27
  28 * :ref:`search`