examples/sphinx/README.md

   1 # Examples files
   2
   3 Examples files for a working (basic) configuration of sphinx.
   4 To be used by all ONAP projects (except 'doc' project).
   5 Extend them to reflect the needs in your project.
   6
   7 We provide two directories:
   8 - **master**: Contains configuration files used in the **development branch**.
   9 - **istanbul**: Contains configuration files used in the **release branch**
  10    (e.g.'istanbul'). **Important**: You need to change the 'istanbul' entries
  11    in the files! Replace them with the name of the new release branch.
  12
  13 The additional directories named *_static* and *images* and the file
  14 *index.rst* are required to make the examples buildable. In the respective
  15 directory you can execute the '*tox -e docs*' command and the build starts.
  16
  17 ## FILE: conf.py
  18 ##### DESCRIPTION:
  19 The “build configuration file” contains (almost) all configuration needed to
  20 customize Sphinx input and output behavior.
  21
  22
  23 ## FILE: conf.yaml
  24 ##### DESCRIPTION:
  25 todo
  26
  27
  28 ## FILE: requirements-docs.txt
  29 ##### DESCRIPTION:
  30 todo
  31
  32
  33 ## FILE: .readthedocs.yaml
  34 ##### DESCRIPTION:
  35 todo
  36
  37
  38 ## FILE: tox.ini
  39 ##### DESCRIPTION:
  40 todo