diff --git a/docs/readthedocs/source/_static/css/custom.css b/docs/readthedocs/source/_static/css/custom.css index e69de29bb2d..768a453843c 100644 --- a/docs/readthedocs/source/_static/css/custom.css +++ b/docs/readthedocs/source/_static/css/custom.css @@ -0,0 +1,13 @@ +/* align items in the left part of header to the ground*/ +.bd-header #navbar-start { + align-items: end; +} + +/* for version badge, possible for other badges*/ +.version-badge{ + border: 1px solid var(--pst-color-primary); + border-radius: 0.25rem; + color: var(--pst-color-primary); + padding: 0.1rem 0.25rem; + font-size: var(--pst-font-size-milli); +} \ No newline at end of file diff --git a/docs/readthedocs/source/_static/image/bigdl_handouts.png b/docs/readthedocs/source/_static/image/bigdl_handouts.png new file mode 100644 index 00000000000..8363f5dde0c Binary files /dev/null and b/docs/readthedocs/source/_static/image/bigdl_handouts.png differ diff --git a/docs/readthedocs/source/_static/js/custom.js b/docs/readthedocs/source/_static/js/custom.js index 92a45b363e2..2f59dbec785 100644 --- a/docs/readthedocs/source/_static/js/custom.js +++ b/docs/readthedocs/source/_static/js/custom.js @@ -1,6 +1,5 @@ $(document).ready(function(){ -// $('.btn.dropdown-toggle.nav-item').text('Libraries'); // change text for dropdown menu in header from More to Libraries - $('.navbar-end-item.navbar-end__search-button-container').remove(); // remove search button from top bar manually +// $('.btn.dropdown-toggle.nav-item').text('Libraries'); // change text for dropdown menu in header from More to Libraries $('#ethical-ad-placement').css({ //weanken the display effect of ads div "transform":"scale(0.3)", // make it smaller "position":"absolute", // modify its position diff --git a/docs/readthedocs/source/_templates/breadcrumbs.html b/docs/readthedocs/source/_templates/breadcrumbs.html deleted file mode 100644 index 599388dca4a..00000000000 --- a/docs/readthedocs/source/_templates/breadcrumbs.html +++ /dev/null @@ -1,60 +0,0 @@ - - -{%- extends "sphinx_rtd_theme/breadcrumbs.html" %} - - -{%- block breadcrumbs_aside %} -
  • - {%- if hasdoc(pagename) and display_vcs_links %} - {%- if display_github %} - {%- if check_meta and 'github_url' in meta %} - - {{ _('Edit this page') }} - {%- else %} - {{ _('Edit this page') }} - {%- endif %} - {%- elif show_source and source_url_prefix %} - {{ _('View page source') }} - {%- elif show_source and has_source and sourcename %} - {{ _('View page source') }} - {%- endif %} - {%- endif %} -
  • -{%- endblock %} \ No newline at end of file diff --git a/docs/readthedocs/source/_templates/sidebar_backbutton.html b/docs/readthedocs/source/_templates/sidebar_backbutton.html new file mode 100644 index 00000000000..fc2482c8000 --- /dev/null +++ b/docs/readthedocs/source/_templates/sidebar_backbutton.html @@ -0,0 +1,6 @@ +{% set home_href = pathto(master_doc) %} +
    + + Back to Homepage ↵ + +
    \ No newline at end of file diff --git a/docs/readthedocs/source/_templates/sidebar_handouts.html b/docs/readthedocs/source/_templates/sidebar_handouts.html new file mode 100644 index 00000000000..46bd5c1e61f --- /dev/null +++ b/docs/readthedocs/source/_templates/sidebar_handouts.html @@ -0,0 +1,7 @@ +
    + BigDL Handouts +
    + + BigDL Handouts + +
    \ No newline at end of file diff --git a/docs/readthedocs/source/_templates/sidebar_releases.html b/docs/readthedocs/source/_templates/sidebar_releases.html new file mode 100644 index 00000000000..32e14bb5e2f --- /dev/null +++ b/docs/readthedocs/source/_templates/sidebar_releases.html @@ -0,0 +1,19 @@ +
    + Versions +
    +
    + latest:  +
    + v2.1.0:  +
    + v2.0.0:  +
    +
    + document +
    + document | release notes +
    + document | release notes +
    +
    +
    \ No newline at end of file diff --git a/docs/readthedocs/source/_templates/version_badge.html b/docs/readthedocs/source/_templates/version_badge.html new file mode 100644 index 00000000000..8eeaa61f7a4 --- /dev/null +++ b/docs/readthedocs/source/_templates/version_badge.html @@ -0,0 +1,3 @@ +
    + {{ release }} +
    \ No newline at end of file diff --git a/docs/readthedocs/source/conf.py b/docs/readthedocs/source/conf.py index 764eba8c2d3..b41b677ee2f 100644 --- a/docs/readthedocs/source/conf.py +++ b/docs/readthedocs/source/conf.py @@ -41,14 +41,21 @@ "icon": "fa-brands fa-square-github", "type": "fontawesome", } - ] + ], + "navbar_start": ["navbar-logo.html", "version_badge.html"] } html_logo = "../image/bigdl_logo.png" # add search bar to side bar html_sidebars = { - "**": ["search-field.html", "sidebar-nav-bs.html"] + "index": [ + "sidebar_releases.html", + "sidebar_handouts.html" + ], + "**": ["sidebar_backbutton.html","sidebar-nav-bs.html"] } +# hard code it for now, may change it to read from installed bigdl +release = "latest" # The suffix of source filenames. from recommonmark.parser import CommonMarkParser