summaryrefslogtreecommitdiffstats
path: root/examples/sphinx/istanbul
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2022-08-16 13:10:56 +0200
committerthmsdt <thomas.kulik@telekom.de>2022-08-16 13:12:20 +0200
commit7e0db8a223e9d7a693c7120a5beb91df40fef82f (patch)
treeef5888d5f390d70d2332e0bdad9c1e2fad3e67b6 /examples/sphinx/istanbul
parent65bec69096b0a2ef18cd72d87b89757da4ae1906 (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/istanbul')
-rw-r--r--examples/sphinx/istanbul/_static/css/ribbon.css63
-rwxr-xr-xexamples/sphinx/istanbul/_static/favicon.icobin2102 -> 0 bytes
-rw-r--r--examples/sphinx/istanbul/_static/logo_onap_2017.pngbin12278 -> 0 bytes
-rw-r--r--examples/sphinx/istanbul/conf.py42
-rw-r--r--examples/sphinx/istanbul/images/biohazard.pngbin179 -> 0 bytes
-rw-r--r--examples/sphinx/istanbul/index.rst132
-rw-r--r--examples/sphinx/istanbul/requirements-docs.txt8
-rw-r--r--examples/sphinx/istanbul/tox.ini77
8 files changed, 0 insertions, 322 deletions
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/istanbul/_static/favicon.ico b/examples/sphinx/istanbul/_static/favicon.ico
deleted file mode 100755
index cb712ebd2..000000000
--- a/examples/sphinx/istanbul/_static/favicon.ico
+++ /dev/null
Binary files differ
diff --git a/examples/sphinx/istanbul/_static/logo_onap_2017.png b/examples/sphinx/istanbul/_static/logo_onap_2017.png
deleted file mode 100644
index 5d064f431..000000000
--- a/examples/sphinx/istanbul/_static/logo_onap_2017.png
+++ /dev/null
Binary files differ
diff --git a/examples/sphinx/istanbul/conf.py b/examples/sphinx/istanbul/conf.py
deleted file mode 100644
index 67944beb6..000000000
--- a/examples/sphinx/istanbul/conf.py
+++ /dev/null
@@ -1,42 +0,0 @@
-project = "onap"
-release = "istanbul"
-version = "istanbul"
-
-author = "Open Network Automation Platform"
-# yamllint disable-line rule:line-length
-copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
-
-pygments_style = "sphinx"
-html_theme = "sphinx_rtd_theme"
-html_theme_options = {
- "style_nav_header_background": "white",
- "sticky_navigation": "False" }
-html_logo = "_static/logo_onap_2017.png"
-html_favicon = "_static/favicon.ico"
-html_static_path = ["_static"]
-html_show_sphinx = False
-
-extensions = [
- 'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
- 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz']
-
-#
-# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
-# Change to {releasename} after you have created the new 'doc' branch.
-#
-
-branch = 'istanbul'
-
-intersphinx_mapping = {}
-doc_url = 'https://docs.onap.org/projects'
-master_doc = 'index'
-
-#
-# Example:
-# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
-#
-
-html_last_updated_fmt = '%d-%b-%y %H:%M'
-
-def setup(app):
- app.add_css_file("css/ribbon.css")
diff --git a/examples/sphinx/istanbul/images/biohazard.png b/examples/sphinx/istanbul/images/biohazard.png
deleted file mode 100644
index ae4629d8b..000000000
--- a/examples/sphinx/istanbul/images/biohazard.png
+++ /dev/null
Binary files differ
diff --git a/examples/sphinx/istanbul/index.rst b/examples/sphinx/istanbul/index.rst
deleted file mode 100644
index c7685a558..000000000
--- a/examples/sphinx/istanbul/index.rst
+++ /dev/null
@@ -1,132 +0,0 @@
-=====================================================
- The reStructuredText_ Cheat Sheet: Syntax Reminders
-=====================================================
-:Info: See <http://docutils.sf.net/rst.html> for introductory docs.
-:Author: David Goodger <goodger@python.org>
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
-:Revision: $Revision: 8631 $
-:Description: This is a "docinfo block", or bibliographic field list
-
-.. NOTE:: If you are reading this as HTML, please read
- `<index.rst>`_ instead to see the input syntax examples!
-
-Section Structure
-=================
-Section titles are underlined or overlined & underlined.
-
-Body Elements
-=============
-Grid table:
-
-+--------------------------------+-----------------------------------+
-| Paragraphs are flush-left, | Literal block, preceded by "::":: |
-| separated by blank lines. | |
-| | Indented |
-| Block quotes are indented. | |
-+--------------------------------+ or:: |
-| >>> print 'Doctest block' | |
-| Doctest block | > Quoted |
-+--------------------------------+-----------------------------------+
-| | Line blocks preserve line breaks & indents. [new in 0.3.6] |
-| | Useful for addresses, verse, and adornment-free lists; long |
-| lines can be wrapped with continuation lines. |
-+--------------------------------------------------------------------+
-
-Simple tables:
-
-================ ============================================================
-List Type Examples (syntax in the `text source <index.rst>`_)
-================ ============================================================
-Bullet list * items begin with "-", "+", or "*"
-Enumerated list 1. items use any variation of "1.", "A)", and "(i)"
- #. also auto-enumerated
-Definition list Term is flush-left : optional classifier
- Definition is indented, no blank line between
-Field list :field name: field body
-Option list -o at least 2 spaces between option & description
-================ ============================================================
-
-================ ============================================================
-Explicit Markup Examples (visible in the `text source`_)
-================ ============================================================
-Footnote .. [1] Manually numbered or [#] auto-numbered
- (even [#labelled]) or [*] auto-symbol
-Citation .. [CIT2002] A citation.
-Hyperlink Target .. _reStructuredText: http://docutils.sf.net/rst.html
- .. _indirect target: reStructuredText_
- .. _internal target:
-Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html
-Directive ("::") .. image:: images/biohazard.png
-Substitution Def .. |substitution| replace:: like an inline directive
-Comment .. is anything else
-Empty Comment (".." on a line by itself, with blank lines before & after,
- used to separate indentation contexts)
-================ ============================================================
-
-Inline Markup
-=============
-*emphasis*; **strong emphasis**; `interpreted text`; `interpreted text
-with role`:emphasis:; ``inline literal text``; standalone hyperlink,
-http://docutils.sourceforge.net; named reference, reStructuredText_;
-`anonymous reference`__; footnote reference, [1]_; citation reference,
-[CIT2002]_; |substitution|; _`inline internal target`.
-
-Directive Quick Reference
-=========================
-See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info.
-
-================ ============================================================
-Directive Name Description (Docutils version added to, in [brackets])
-================ ============================================================
-attention Specific admonition; also "caution", "danger",
- "error", "hint", "important", "note", "tip", "warning"
-admonition Generic titled admonition: ``.. admonition:: By The Way``
-image ``.. image:: picture.png``; many options possible
-figure Like "image", but with optional caption and legend
-topic ``.. topic:: Title``; like a mini section
-sidebar ``.. sidebar:: Title``; like a mini parallel document
-parsed-literal A literal block with parsed inline markup
-rubric ``.. rubric:: Informal Heading``
-epigraph Block quote with class="epigraph"
-highlights Block quote with class="highlights"
-pull-quote Block quote with class="pull-quote"
-compound Compound paragraphs [0.3.6]
-container Generic block-level container element [0.3.10]
-table Create a titled table [0.3.1]
-list-table Create a table from a uniform two-level bullet list [0.3.8]
-csv-table Create a table from CSV data [0.3.4]
-contents Generate a table of contents
-sectnum Automatically number sections, subsections, etc.
-header, footer Create document decorations [0.3.8]
-target-notes Create an explicit footnote for each external target
-math Mathematical notation (input in LaTeX format)
-meta Document metadata
-include Read an external reST file as if it were inline
-raw Non-reST data passed untouched to the Writer
-replace Replacement text for substitution definitions
-unicode Unicode character code conversion for substitution defs
-date Generates today's date; for substitution defs
-class Set a "class" attribute on the next element
-role Create a custom interpreted text role [0.3.2]
-default-role Set the default interpreted text role [0.3.10]
-title Set the metadata document title [0.3.10]
-================ ============================================================
-
-Interpreted Text Role Quick Reference
-=====================================
-See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info.
-
-================ ============================================================
-Role Name Description
-================ ============================================================
-emphasis Equivalent to *emphasis*
-literal Equivalent to ``literal`` but processes backslash escapes
-math Mathematical notation (input in LaTeX format)
-PEP Reference to a numbered Python Enhancement Proposal
-RFC Reference to a numbered Internet Request For Comments
-raw For non-reST data; cannot be used directly (see docs) [0.3.6]
-strong Equivalent to **strong**
-sub Subscript
-sup Superscript
-title Title reference (book, etc.); standard default role
-================ ============================================================
diff --git a/examples/sphinx/istanbul/requirements-docs.txt b/examples/sphinx/istanbul/requirements-docs.txt
deleted file mode 100644
index dc55d67b4..000000000
--- a/examples/sphinx/istanbul/requirements-docs.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-sphinx>=4.2.0 # BSD
-sphinx-rtd-theme>=1.0.0 # MIT
-sphinxcontrib-blockdiag # BSD
-sphinxcontrib-seqdiag # BSD
-sphinxcontrib-swaggerdoc
-autopep8
-sphinxcontrib-spelling
-pylint
diff --git a/examples/sphinx/istanbul/tox.ini b/examples/sphinx/istanbul/tox.ini
deleted file mode 100644
index 6505b8512..000000000
--- a/examples/sphinx/istanbul/tox.ini
+++ /dev/null
@@ -1,77 +0,0 @@
-[tox]
-minversion = 1.6
-envlist = docs,docs-linkcheck
-skipsdist = true
-
-[testenv:docs]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
- sh
-
-[testenv:docs-templates]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates
- echo "Generated docs available in {toxinidir}/docs/_build/html/templates"
-whitelist_externals =
- echo
-
-[testenv:local]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- git submodule update --depth 100 --init
- sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
-
-[testenv:docs-linkcheck]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-
-[testenv:spellcheck]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
-
-[testenv:autopep8]
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- autopep8 --max-line-length 120 --in-place docs/conf.py
-
-[testenv:pylint]
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py