saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

added custom search for each branch, fixed style issues

Browse source
This commit is contained in:
Jacob Hammons 2015-05-22 11:53:33 -06:00
parent 55732ab260
commit 1e1eb2b3ea
3 changed files with 45 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/_themes/saltstack2/layout.html vendored
View file

@ -53,6 +53,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ url_root }}',
VERSION: '{{ release|e }}',
SEARCH_CX: '{{ search_cx }}',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
@ -158,8 +159,8 @@
{% if on_saltstack %}
<div class="versions">
<a id="latest" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release_version }} </a> {% if build_type == "latest" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="previous" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release_version }} </a> {% if build_type == "previous" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="latest" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }} </a> {% if build_type == "latest" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="previous" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }} </a> {% if build_type == "previous" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="develop" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Recent doc build from the develop branch" href="/en/develop/">Develop </a> {% if build_type == "develop" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %}
</div>
@ -265,13 +266,13 @@
<div class="col-sm-6">
{% if build_type == "latest" %}
<p>You are viewing docs for the latest stable release, {{ latest_release_version }}. Switch to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release_version }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
<p>You are viewing docs for the latest stable release, {{ latest_release }}. Switch to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
{% elif build_type == "previous" %}
<p>You are viewing docs for the previous stable release, {{ previous_release_version }}. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release_version }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
<p>You are viewing docs for the previous stable release, {{ previous_release }}. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
{% elif build_type == "develop" %}
<p>You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release_version }}</a>, or to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release_version }}</a>.</p>
<p>You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }}</a>.</p>
{% endif %}
<br>

19
doc/_themes/saltstack2/static/js/webhelp.min.js vendored
View file

@ -140,9 +140,14 @@ $( document ).ready(function() {
$( '#search-form' ).find( 'input' ).keypress(function(e) {
if(e.which == 13) {
var cx = '004624818632696854117:yfmprrbw3pk&q=';
'find which search instance to use'
if (DOCUMENTATION_OPTIONS.SEARCH_CX) {
cx = DOCUMENTATION_OPTIONS.SEARCH_CX;
}
var searchterm = encodeURIComponent($(this).val());
$(this).val("");
window.location.href = 'https://www.google.com/cse?cx=004624818632696854117:yfmprrbw3pk&q=' + searchterm;
window.location.href = 'https://www.google.com/cse?cx=' + cx + '&q=' + searchterm;
}
});
@ -152,7 +157,6 @@ $( document ).ready(function() {
$( '#wrapper' ).toggleClass( 'toggled' );
});
}); // $.document.ready
//refresh on window resize
@ -160,10 +164,13 @@ var rtime = new Date(1, 1, 2000, 12,00,00);
var timeout = false;
var delta = 200;
$(window).resize(function() {
rtime = new Date();
if (timeout === false) {
timeout = true;
setTimeout(resizeend, delta);
if (!$( '#menu-toggle' ).is(":visible")) {
rtime = new Date();
if (timeout === false) {
timeout = true;
setTimeout(resizeend, delta);
}
}
});

34
doc/conf.py
View file

@ -161,8 +161,25 @@ project = 'Salt'
copyright = '2015 SaltStack, Inc.'
version = salt.version.__version__
#release = '.'.join(map(str, salt.version.__version_info__))
release = '2015.5.0' # also update release versions in 'html_context'
latest_release = '2015.5.0' # latest release
previous_release = '2014.7.6' # latest release from previous branch
previous_release_dir = '2014.7' # path on web server for previous branch
build_type = 'develop' # latest, previous, develop
# set release to 'version' for develop so sha is used
# - otherwise -
# set release to 'latest_release' or 'previous_release'
release = version # version, latest_release, previous_release
# Set google custom search engine
if release == latest_release:
search_cx = '004624818632696854117:yfmprrbw3pk'
elif release.startswith('2014.7'):
search_cx = '004624818632696854117:thhslradbru'
else:
search_cx = '004624818632696854117:haj7bjntf4s' # develop
needs_sphinx = '1.3'
@ -206,7 +223,7 @@ rst_prolog = """\
.. _`salt-users`: https://groups.google.com/forum/#!forum/salt-users
.. _`salt-announce`: https://groups.google.com/forum/#!forum/salt-announce
.. _`salt-packagers`: https://groups.google.com/forum/#!forum/salt-packagers
""".format(release=release)
""".format(release=latest_release)
# A shortcut for linking to tickets on the GitHub issue tracker
extlinks = {
@ -275,10 +292,11 @@ html_context = {
'github_base': 'https://github.com/saltstack/salt',
'github_issues': 'https://github.com/saltstack/salt/issues',
'github_downloads': 'https://github.com/saltstack/salt/downloads',
'latest_release_version': '2015.5.0',
'previous_release_version': '2014.7.6',
'previous_release_dir': '2014.7',
'build_type': 'latest', #latest, previous, develop
'latest_release': latest_release,
'previous_release': previous_release,
'previous_release_dir': previous_release_dir,
'search_cx': search_cx,
'build_type': build_type,
}
html_use_index = True
@ -404,4 +422,4 @@ class ReleasesTree(TocTree):
def setup(app):
app.add_directive('releasestree', ReleasesTree)
app.connect('autodoc-skip-member', skip_mod_init_member)
app.connect('autodoc-skip-member', skip_mod_init_member)