diff options
author | thmsdt <thomas.kulik@telekom.de> | 2022-08-16 13:10:56 +0200 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2022-08-16 13:12:20 +0200 |
commit | 7e0db8a223e9d7a693c7120a5beb91df40fef82f (patch) | |
tree | ef5888d5f390d70d2332e0bdad9c1e2fad3e67b6 /examples/sphinx/README.md | |
parent | 65bec69096b0a2ef18cd72d87b89757da4ae1906 (diff) |
update sphinx example config files
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I74a213993ada2b3697b58270c30c61326b151f7b
Diffstat (limited to 'examples/sphinx/README.md')
-rw-r--r-- | examples/sphinx/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/examples/sphinx/README.md b/examples/sphinx/README.md index ec94cd0b1..8c1e339e4 100644 --- a/examples/sphinx/README.md +++ b/examples/sphinx/README.md @@ -6,9 +6,9 @@ in your project. **Important:** The files relate on each other. Change them care 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 (e.g. 'jakarta'). +- **release**: Contains configuration files used in the **release branch** + (e.g.'kohn'). **Important:** You need to change the 'kohn' 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 |