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 Please note the different pathes, the files are located in!
   7
   8 ## FILE: tox.ini_MASTER
   9
  10 ##### USE:
  11 in MASTER branch of your repository
  12 ##### PATH:
  13 {project}/docs
  14 ##### TODO:
  15 remove _MASTER from filename
  16
  17 ## FILE: tox.ini_NEWBRANCH
  18
  19 ##### USE:
  20 in 'NEWBRANCH' of your repository
  21 ##### PATH:
  22 {project}/docs
  23 ##### TODO:
  24 remove _NEWBRANCH from filename
  25
  26 update release name in the following lines:
  27 ```
  28 -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=istanbul
  29 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=istanbul
  30 ```
  31
  32 ## FILE: conf.py_MASTER
  33
  34 ##### USE:
  35 in MASTER branch of your repository
  36 ##### PATH:
  37 {project}/docs
  38 ##### TODO:
  39 remove _MASTER from filename
  40
  41 ## FILE: conf.py_NEWBRANCH
  42
  43 ##### USE:
  44 in 'NEWBRANCH' of your repository
  45 ##### PATH:
  46 {project}/docs
  47 ##### TODO:
  48 remove _NEWBRANCH from filename
  49
  50 ## FILE: requirements-docs.txt
  51
  52 ##### USE:
  53 in both, MASTER branch and 'NEWBRANCH' of your repository
  54 ##### PATH:
  55 {project}/docs
  56 ##### TODO:
  57 –
  58
  59 ## FILE: .readthedocs.yaml
  60
  61 ##### USE:
  62 in both, MASTER branch and 'NEWBRANCH' of your repository
  63 ##### PATH:
  64 {project}
  65 ##### TODO:
  66 –