Applying Piccolo theme

Signed-off-by: xudan16 <xudan16@huawei.com>
Change-Id: If169f3250aaa8ba326919c98fb36170eb8402232
Reviewed-on: https://gerrit.opnfv.org/gerrit/c/kuberef/+/73866
Tested-by: jenkins-ci <jenkins-opnfv-ci@opnfv.org>
Reviewed-by: Gergely Csatari <gergely.csatari@nokia.com>

diff --git a/docs/_static/anuket-logo.png b/docs/_static/anuket-logo.png
new file mode 100644 (file)
index 0000000..fe256a6
Binary files /dev/null and b/docs/_static/anuket-logo.png differ

diff --git a/docs/_static/custom.css b/docs/_static/custom.css
new file mode 100644 (file)
index 0000000..46c9616
--- /dev/null
+++ b/docs/_static/custom.css
@@ -0,0 +1,66 @@
+/* Changing the color of top navbar in piccolo */
+div#top_nav nav {
+    background-color: #16326c;
+    padding:0.5rem;
+}
+
+/* Changing the size of the logo in the top navbar in piccolo */
+div#top_nav nav h1 img {
+       height: 2rem;
+}
+
+/* Changing the margin of the main text in piccolo */
+div.document {
+       margin-left: 10rem;
+       margin-right: 20rem;
+}
+
+/* Changing link color in piccolo */
+a {
+       color: #007574ff;
+}
+
+/* Changing link color in the left sidebar in piccolo */
+div.sphinxsidebar ul li a.current {
+       color: #007574ff;
+}
+
+/* Changing the hover color in the left sidebar in piccolo */
+div.sphinxsidebar ul li a:hover {
+       color: #007574ff;
+}
+
+/* Changing the hover color in the right sidebar in piccolo */
+div#right_sidebar ul li a:hover {
+       color: #007574ff;
+}
+
+/* Changing the color of the > icon next to Page contents */
+div#right_sidebar p span.icon {
+       color: #007574ff;
+}
+
+/* Changing the color of the Page contents title */
+div#right_sidebar p span {
+       color: #007574ff;
+}
+
+/* Changing the color of the search button */
+div.document form input[type=submit], div.document form button {
+       background-color: #16326c;
+}
+
+/* Changing the color of the Search text in the Search button */
+div#searchbox form.search input[type="submit"] {
+       color: #16326c;
+}
+
+/* Changing the color of the > icon next to the collapsed Page contents */
+div#show_right_sidebar p span.icon {
+       color: rgba(0, 0, 0, 0.6);
+}
+
+/* Removing option to switch to dark mode */
+div#top_nav nav a#mode_toggle, div#top_nav nav a#source_link {
+       display: none;
+}
\ No newline at end of file

diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100644 (file)
index 0000000..3d410f6
Binary files /dev/null and b/docs/_static/favicon.ico differ

diff --git a/docs/conf.py b/docs/conf.py
index 61f42e3..395925b 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,11 +1,47 @@
-# SPDX-FileCopyrightText: 2021 Anuket contributors
-#
-# SPDX-License-Identifier: Apache-2.0
+project = 'kuberef'
+html_title = "kuberef"
+copyright = '2023, Anuket. Licensed under CC BY 4.0'
+author = 'Anuket Project of Linux Foundation Networking'
 
-""" for docs
-"""
+exclude_patterns = [
+    '.tox',
+    'README.rst'
+]
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosectionlabel'
+]
+html_theme = "piccolo_theme"
+linkcheck_ignore = [
+    'http://127.0.0.1'
+]
+intersphinx_mapping = {
+    'cntt': ('https://cntt.readthedocs.io/en/latest/', None),
+    'ref_model': ('https://cntt.readthedocs.io/projects/rm/en/latest/', None),
+    'ref_arch_kubernetes': ('https://cntt.readthedocs.io/projects/ra2/en/latest/', None),
+    'ref_cert_RC2': ('https://cntt.readthedocs.io/projects/rc2/en/latest/', None),
+    'ref_impl_RI2': ('https://cntt.readthedocs.io/projects/ri2/en/latest/', None)
+}
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth = 3
+numfig = True
+numfig_format = {'figure': 'Figure %s', 'table': 'Table %s',
+                 'code-block': 'Listing %s', 'section': 'Section %s'}
 
-# pylint: disable=import-error
-# flake8: noqa
-from docs_conf.conf import *
-copyright = '2021, Anuket. Licensed under CC BY 4.0'
+html_static_path = ['_static']
+templates_path = ['_templates']
+html_css_files = [
+    'custom.css',
+]
+
+html_show_sourcelink = False
+html_theme_options = {
+    # If False, expand all TOC entries
+    'globaltoc_collapse': False,
+    # If True, show hidden TOC entries
+    'globaltoc_includehidden': False,
+}
+
+# Inverse png
+html_logo = '_static/anuket-logo.png'
+html_favicon = '_static/favicon.ico'

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 92d8e94..9bb07ca 100644 (file)
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -2,5 +2,6 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-lfdocs-conf
-sphinx_opnfv_theme
+sphinx
+doc8
+piccolo-theme