diff options
| -rw-r--r-- | .gitreview | 1 | ||||
| -rw-r--r-- | docs/_static/css/ribbon.css | 22 | ||||
| -rw-r--r-- | docs/conf.py | 25 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 6 |
5 files changed, 29 insertions, 32 deletions
@@ -2,3 +2,4 @@ host=gerrit.onap.org port=29418 project=ccsdk/distribution.git +defaultbranch=master diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 7a05d4c0..d03a26b2 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -14,9 +14,9 @@ -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; @@ -29,35 +29,35 @@ 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/docs/conf.py b/docs/conf.py index b5a0c2fa..a9c42b67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,9 +3,9 @@ release = "master" version = "master" 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 = { @@ -15,7 +15,7 @@ html_logo = "_static/logo_onap_2017.png" html_favicon = "_static/favicon.ico" html_static_path = ["_static"] html_show_sphinx = False - + extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.graphviz', @@ -24,34 +24,33 @@ extensions = [ 'sphinxcontrib.swaggerdoc', 'sphinxcontrib.plantuml' ] - + # # 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 = 'latest' - + intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' master_doc = 'index' - + exclude_patterns = ['.tox'] - + spelling_word_list_filename='spelling_wordlist.txt' spelling_lang = "en_GB" - + # # 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") - + linkcheck_ignore = [ r'http://localhost:\d+/' ] - diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab592813..00000000 --- a/docs/conf.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -project_cfg: onap -project: onap - -# Change this to ReleaseBranchName to modify the header -default-version: latest -# diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 3b3441a8..ba3e0ec0 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,3 +1,7 @@ -lfdocs-conf sphinx>=4.2.0 # BSD sphinx-rtd-theme>=1.0.0 # MIT +sphinxcontrib-blockdiag # BSD +sphinxcontrib-seqdiag # BSD +sphinxcontrib-swaggerdoc +sphinxcontrib-spelling +sphinxcontrib-plantuml
\ No newline at end of file |