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