Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RI1]: Adding Piccolo theme #3365

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/ref_impl/cntt-ri/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.10"

# Build from the root directory with Sphinx
sphinx:
configuration: conf.py

# Explicitly set the version of Python and its requirements
python:
install:
- requirements: test-requirements.txt
Binary file added doc/ref_impl/cntt-ri/_static/anuket-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions doc/ref_impl/cntt-ri/_static/custom.css
Original file line number Diff line number Diff line change
@@ -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;
}
Binary file added doc/ref_impl/cntt-ri/_static/favicon.ico
Binary file not shown.
25 changes: 24 additions & 1 deletion doc/ref_impl/cntt-ri/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
'sphinx.ext.intersphinx',
'sphinx.ext.autosectionlabel'
]

html_theme = "piccolo_theme"


linkcheck_ignore = [
'http://127.0.0.1',
'https://trex-tgn.cisco.com',
Expand All @@ -20,8 +24,8 @@
'http://artifacts.opnfv.org/',
'https://build.opnfv.org/',
'https://wiki.lfnetworking.org/'

]

intersphinx_mapping = {
'cntt': ('https://cntt.readthedocs.io/en/latest/', None),
'ref_model': ('https://cntt.readthedocs.io/projects/rm/en/latest/', None),
Expand All @@ -32,3 +36,22 @@
numfig = True
numfig_format = {'figure': 'Figure %s', 'table': 'Table %s',
'code-block': 'Listing %s', 'section': 'Section %s'}

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'
7 changes: 3 additions & 4 deletions doc/ref_impl/cntt-ri/test-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
sphinx!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0,!=3.4.2
sphinx-rtd-theme
doc8
sphinx_material
sphinx==4.5.0 # BSD
doc8==0.11.2 # Apache-2.0
piccolo-theme==0.16.0 # MIT