From 7e0db8a223e9d7a693c7120a5beb91df40fef82f Mon Sep 17 00:00:00 2001 From: thmsdt Date: Tue, 16 Aug 2022 13:10:56 +0200 Subject: [PATCH] update sphinx example config files Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: I74a213993ada2b3697b58270c30c61326b151f7b --- examples/sphinx/README.md | 6 +- examples/sphinx/istanbul/_static/css/ribbon.css | 63 --------------------- examples/sphinx/release/_static/css/ribbon.css | 63 +++++++++++++++++++++ .../{istanbul => release}/_static/favicon.ico | Bin .../_static/logo_onap_2017.png | Bin examples/sphinx/{istanbul => release}/conf.py | 6 +- .../{istanbul => release}/images/biohazard.png | Bin examples/sphinx/{istanbul => release}/index.rst | 0 .../{istanbul => release}/requirements-docs.txt | 0 examples/sphinx/{istanbul => release}/tox.ini | 0 10 files changed, 69 insertions(+), 69 deletions(-) delete mode 100644 examples/sphinx/istanbul/_static/css/ribbon.css create mode 100644 examples/sphinx/release/_static/css/ribbon.css rename examples/sphinx/{istanbul => release}/_static/favicon.ico (100%) rename examples/sphinx/{istanbul => release}/_static/logo_onap_2017.png (100%) rename examples/sphinx/{istanbul => release}/conf.py (94%) rename examples/sphinx/{istanbul => release}/images/biohazard.png (100%) rename examples/sphinx/{istanbul => release}/index.rst (100%) rename examples/sphinx/{istanbul => release}/requirements-docs.txt (100%) rename examples/sphinx/{istanbul => release}/tox.ini (100%) 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 diff --git a/examples/sphinx/istanbul/_static/css/ribbon.css b/examples/sphinx/istanbul/_static/css/ribbon.css deleted file mode 100644 index 6008cb1a0..000000000 --- a/examples/sphinx/istanbul/_static/css/ribbon.css +++ /dev/null @@ -1,63 +0,0 @@ -.ribbon { - z-index: 1000; - background-color: #a00; - overflow: hidden; - white-space: nowrap; - position: fixed; - top: 25px; - right: -50px; - -webkit-transform: rotate(45deg); - -moz-transform: rotate(45deg); - -ms-transform: rotate(45deg); - -o-transform: rotate(45deg); - transform: rotate(45deg); - -webkit-box-shadow: 0 0 10px #888; - -moz-box-shadow: 0 0 10px #888; - box-shadow: 0 0 10px #888; - -} - -.ribbon a { - border: 1px solid #faa; - color: #fff; - display: block; - font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; - margin: 1px 0; - padding: 10px 50px; - text-align: center; - text-decoration: none; - text-shadow: 0 0 5px #444; - transition: 0.5s; -} - -.ribbon a:hover { - background: #c11; - color: #fff; -} - - -/* override table width restrictions */ -@media screen and (min-width: 767px) { - - .wy-table-responsive table td, .wy-table-responsive table th { - /* !important prevents the common CSS stylesheets from overriding - this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; - } - - .wy-table-responsive { - overflow: visible !important; - } -} - -@media screen and (max-width: 767px) { - .wy-table-responsive table td { - white-space: nowrap; - } -} - -/* fix width of the screen */ - -.wy-nav-content { - max-width: none; -} diff --git a/examples/sphinx/release/_static/css/ribbon.css b/examples/sphinx/release/_static/css/ribbon.css new file mode 100644 index 000000000..d03a26b20 --- /dev/null +++ b/examples/sphinx/release/_static/css/ribbon.css @@ -0,0 +1,63 @@ +.ribbon { + z-index: 1000; + background-color: #a00; + overflow: hidden; + white-space: nowrap; + position: fixed; + top: 25px; + right: -50px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -ms-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + -webkit-box-shadow: 0 0 10px #888; + -moz-box-shadow: 0 0 10px #888; + box-shadow: 0 0 10px #888; + + } + + .ribbon a { + border: 1px solid #faa; + color: #fff; + display: block; + font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; + margin: 1px 0; + padding: 10px 50px; + text-align: center; + text-decoration: none; + text-shadow: 0 0 5px #444; + transition: 0.5s; + } + + .ribbon a:hover { + background: #c11; + color: #fff; + } + + + /* override table width restrictions */ + @media screen and (min-width: 767px) { + + .wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from overriding + this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; + } + + .wy-table-responsive { + overflow: visible !important; + } + } + + @media screen and (max-width: 767px) { + .wy-table-responsive table td { + white-space: nowrap; + } + } + + /* fix width of the screen */ + + .wy-nav-content { + max-width: 800px; + } \ No newline at end of file diff --git a/examples/sphinx/istanbul/_static/favicon.ico b/examples/sphinx/release/_static/favicon.ico similarity index 100% rename from examples/sphinx/istanbul/_static/favicon.ico rename to examples/sphinx/release/_static/favicon.ico diff --git a/examples/sphinx/istanbul/_static/logo_onap_2017.png b/examples/sphinx/release/_static/logo_onap_2017.png similarity index 100% rename from examples/sphinx/istanbul/_static/logo_onap_2017.png rename to examples/sphinx/release/_static/logo_onap_2017.png diff --git a/examples/sphinx/istanbul/conf.py b/examples/sphinx/release/conf.py similarity index 94% rename from examples/sphinx/istanbul/conf.py rename to examples/sphinx/release/conf.py index 67944beb6..b2ba93216 100644 --- a/examples/sphinx/istanbul/conf.py +++ b/examples/sphinx/release/conf.py @@ -1,6 +1,6 @@ project = "onap" -release = "istanbul" -version = "istanbul" +release = "kohn" +version = "kohn" author = "Open Network Automation Platform" # yamllint disable-line rule:line-length @@ -25,7 +25,7 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # -branch = 'istanbul' +branch = 'kohn' intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' diff --git a/examples/sphinx/istanbul/images/biohazard.png b/examples/sphinx/release/images/biohazard.png similarity index 100% rename from examples/sphinx/istanbul/images/biohazard.png rename to examples/sphinx/release/images/biohazard.png diff --git a/examples/sphinx/istanbul/index.rst b/examples/sphinx/release/index.rst similarity index 100% rename from examples/sphinx/istanbul/index.rst rename to examples/sphinx/release/index.rst diff --git a/examples/sphinx/istanbul/requirements-docs.txt b/examples/sphinx/release/requirements-docs.txt similarity index 100% rename from examples/sphinx/istanbul/requirements-docs.txt rename to examples/sphinx/release/requirements-docs.txt diff --git a/examples/sphinx/istanbul/tox.ini b/examples/sphinx/release/tox.ini similarity index 100% rename from examples/sphinx/istanbul/tox.ini rename to examples/sphinx/release/tox.ini -- 2.16.6