-
Notifications
You must be signed in to change notification settings - Fork 1.7k
DOCS-454 make docs version aware and add version navigator #728
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
Closed
Closed
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,10 @@ | ||
| <h3><a href="{{ pathto(master_doc) }}">{{ shorttitle }}</a> | ||
| {% if theme_project != 'about' %} | ||
| <small><a href="{{ pathto('genindex') }}">{{ _('(Index)') }}</a></small> | ||
| {% endif %} | ||
| {% endif -%} | ||
| </h3> | ||
|
|
||
| {% if theme_project == 'manual' %} | ||
| {# the following span is replaced by the javascript in versionnav.html #} | ||
| <h4 id="vnd">Versions: <span id="vn">{{version}}</span></h4> | ||
| {% endif %} | ||
| {{ toctree(maxdepth=-1) }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <script type="text/javascript"> | ||
| var versions = {{theme_versions}} | ||
| function vfnav() { | ||
| if (DOCUMENTATION_OPTIONS.PAGENAME=='index'){pn=''} | ||
| else {pn=DOCUMENTATION_OPTIONS.PAGENAME} | ||
| v = $(this).children("option:selected").attr('value') | ||
| if ((v==0)||(v=='{{theme_stable}}')) {uri = '/manual/' +'/' + pn} | ||
| else {uri = '{{theme_version_uri}}' + v + '/' + pn} | ||
| window.location.href= uri; | ||
| } | ||
| $(document).ready(function(){ | ||
| $("#vn").html(function(){ | ||
| s=$("<select/>"); | ||
| o='<option/>'; | ||
| $.each(versions,function(index, version) { | ||
| if (version.v == '{{theme_stable}}') {$(o,{value:version.v,text: version.t + ' (stable)'}).appendTo(s);dv=true;} | ||
| else {$(o, {value: version.v, text: version.t}).appendTo(s);}}) | ||
| if (dv==false) {$(o, {value:0,text:'Stable'}).appendTo(s);} | ||
| return(s); | ||
| }); | ||
| $("#vn select").bind('change', vfnav); | ||
| $('#vn select').val(DOCUMENTATION_OPTIONS.VERSION); | ||
| }); | ||
| </script> | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is, to be clear, a list of python dicts. and might be fragile if your JS expects keys to appear in a certain order.
also more descriptive field names might be more clear in the future
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also we shouldn't hard code this like this, but I'll capture this information from the meta script and make a pull request against this tonight if I can manage, or tomorrow.