Skip to content

Commit

Permalink
adjust docs for versioning
Browse files Browse the repository at this point in the history
JIRA: CI-463
  • Loading branch information
adamdebek committed Nov 20, 2024
1 parent 80ba7b3 commit f2f23ad
Show file tree
Hide file tree
Showing 5 changed files with 163 additions and 4 deletions.
108 changes: 105 additions & 3 deletions _static/css/furo-phoenix.css
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,115 @@ img {
border-right: none !important;
box-sizing: border-box;
display: flex;
justify-content: flex-start !important;
width: 17em !important
justify-content: flex-end;
flex-direction: column !important;
height: 100vh !important;
width: 17em !important;
position: fixed !important
}

.sidebar-container {
box-sizing: border-box;
width: 17em !important
width: inherit !important;
overflow-y: auto !important;
flex-grow: 1 !important
}

.sidebar-sticky {
height: 100% !important
}

.version-container.shift-up {
width: inherit !important;
border-top: 2px solid #c2cbcb !important;
background-color: #f1f3f3 !important;
font-family: 'Open Sans', sans-serif !important;
font-weight: 600 !important;
color: var(--color-sidebar-link-text--top-level) !important
}

.version-container {
width: inherit !important;
border-top: 2px solid #c2cbcb !important;
background-color: #f1f3f3 !important;
font-family: 'Open Sans', sans-serif !important;
font-weight: 600 !important;
color: var(--color-sidebar-link-text--top-level) !important
}

.default-version {
display: flex !important;
justify-content: space-between !important;
cursor: pointer !important
}

.default-version:hover {
background-color: #ea5b22 !important;
color: white !important
}

.default-version > label {
display: flex !important;
align-items: center !important;
justify-content: center !important;
cursor: pointer !important;
width: var(--sidebar-expander-width) !important;
height: var(--sidebar-item-height) !important
}

.version-top {
flex: 1 !important;
display: flex !important;
justify-content: space-between !important;
align-items: center !important;
padding-left: 10px !important
}

.version-container.shift-up > .default-version label > .icon > svg {
transform: rotate(-90deg) !important
}

.default-version label > .icon > svg {
transform: rotate(90deg) !important
}

.version-container.shift-up .other-versions {
margin-right: 10px !important;
margin-left: 10px !important;
box-sizing: border-box !important;
display: block !important
}

.other-versions {
margin-right: 10px !important;
margin-left: 10px !important;
box-sizing: border-box !important;
display: none !important
}

.other-versions > dl {
margin-top: 7px !important
}

.other-versions > dl > dd {
display: inline-block !important;
margin: 0 !important;
padding: 5px !important
}

.other-versions > dl > dd > a {
text-decoration: none !important;
font-weight: 500 !important;
color: var(--color-sidebar-link-text--top-level) !important
}

.other-versions > dl > dd > a:hover {
font-weight: 500 !important;
color: #ea5b22 !important
}

.main {
margin-left: 17em !important
}

/* Hide sidebar brand text */
Expand Down
27 changes: 27 additions & 0 deletions _static/js/versions.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
const curr_version = document.querySelector('.curr-version');
const currentPath = window.location.pathname;
const pathSegments = currentPath.split('/').filter(segment => segment !== '');
const firstItem = pathSegments[0] || null;

if (firstItem !== null) {
curr_version.textContent = 'v: ' + firstItem;
}
else {
curr_version.textContent = 'None';
}

const versions = document.querySelector('.other-versions');

versions.querySelectorAll('a').forEach(anchor => {
anchor.addEventListener('click', function() {
baseTag.href = 'https://docs.phoenix-rtos.com/' + anchor.textContent + '/';
});
});

const triggerElement = document.querySelector('.default-version');
const versionContainer = document.querySelector('.version-container');
const sidebarContainer = document.querySelector('.sidebar-container');

triggerElement.addEventListener('click', function() {
versionContainer.classList.toggle('shift-up');
});
1 change: 1 addition & 0 deletions _templates/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
</div>
{% endblock left_sidebar %}
</div>
{% include "versions.html" %}
</aside>
<div class="main">
<div class="content">
Expand Down
19 changes: 19 additions & 0 deletions _templates/versions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<div class="version-container">
<div class="default-version">
<span class="version-top">
<span>Phoenix-RTOS</span>
<span class="curr-version">v: latest</span>
</span>
<label>
<i class="icon"><svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg></i>
</label>
</div>
<div class="other-versions">
<dl>
<span>Document Release Versions:</span>
{% for name, url in versions %}
<dd><a href="{{ url }}">{{ name }}</a></dd>
{% endfor %}
</dl>
</div>
</div>
12 changes: 11 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,19 @@
html_title = 'Phoenix-RTOS Documentation'
html_favicon = '_images/RTOS_sign.png'
html_theme = 'furo'
html_js_files = ['js/functions.js']
html_js_files = ['js/functions.js', 'js/versions.js']
html_style = ['css/furo-phoenix.css', 'css/furo-extensions-phoenix.css']
html_static_path = ['_static', '_images']
html_baseurl = "https://docs.phoenix-rtos.com/latest/"
html_context = {
"versions": (
("latest", "/"),
("1.0.0", "/1.0.0/"),
("1.0.1", "/1.0.1/"),
("1.0.2", "/1.0.2/"),
)
}

# TODO: add dark mode support
html_theme_options = {
"light_logo": "light_logo.png",
Expand Down

0 comments on commit f2f23ad

Please sign in to comment.