Skip to content

Commit ac7d1e1

Browse files
authored
Merge pull request #42 from UbiquityRobotics/jazzy-devel
The PR includes: Added UR logo to the documentation. Moved the documentation version selector to the right bottom side of the screen for more visibility of the versions and the section titles. Added links to legacy documentation. General language fixes and updates to the documentation.
2 parents f1652c7 + ad2ba81 commit ac7d1e1

File tree

21 files changed

+200
-57
lines changed

21 files changed

+200
-57
lines changed
-68.8 KB
Binary file not shown.
67.8 KB
Loading
-5.66 KB
Binary file not shown.
8.71 KB
Loading

docs/_static/custom.css

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,52 @@ pre,
5353
/* horizontal scroll if code is long */
5454
white-space: pre-wrap;
5555
/* optional: wrap long lines */
56+
}
57+
58+
/* Logo - ensures the logo to show nicely in sidebar */
59+
.wy-side-nav-search .logo,
60+
.wy-side-nav-search>a:first-child {
61+
display: block;
62+
text-align: center;
63+
}
64+
65+
/* Version Controller - makes floating version controller on the bottom right side of the screen. */
66+
.rst-versions {
67+
position: fixed !important;
68+
bottom: 10px;
69+
left: auto !important;
70+
right: 10px;
71+
width: 200px;
72+
height: auto;
73+
display: inline-block !important;
74+
background: #2c2c2c;
75+
z-index: 9999;
76+
}
77+
78+
.rst-current-version {
79+
color: #fff;
80+
cursor: pointer;
81+
display: block;
82+
}
83+
84+
.rst-other-versions {
85+
display: none;
86+
position: absolute;
87+
bottom: 100%;
88+
right: 0;
89+
background: #333;
90+
}
91+
92+
.rst-other-versions a {
93+
color: #ddd;
94+
text-decoration: none;
95+
display: block;
96+
}
97+
98+
.rst-other-versions a:hover {
99+
color: #fff;
100+
}
101+
102+
.wy-nav-side {
103+
padding-bottom: 0 !important;
56104
}

docs/_static/custom.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Adding logic for button on version controller to work:
2+
document.addEventListener('DOMContentLoaded', function () {
3+
const current = document.querySelector('.rst-current-version');
4+
const others = document.querySelector('.rst-other-versions');
5+
6+
if (current && others) {
7+
current.addEventListener('click', function (e) {
8+
e.stopPropagation();
9+
others.style.display = (others.style.display === 'block') ? 'none' : 'block';
10+
});
11+
12+
document.addEventListener('click', function () {
13+
others.style.display = 'none';
14+
});
15+
}
16+
});
17+
18+
4.73 MB
Loading
4.72 MB
Loading
18.2 KB
Loading

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,14 @@
3636
html_theme = 'sphinx_rtd_theme'
3737
html_static_path = ['_static']
3838

39+
html_logo = "_static/logos/UbiquityRobotics_Logo_Full_White.png"
40+
3941
html_css_files = [
4042
'custom.css'
4143
]
4244

45+
html_js_files = ['custom.js']
46+
4347
# -- RTD lower-left menu setup -----------------------------------------------
4448
try:
4549
html_context

0 commit comments

Comments
 (0)