diff --git a/doc/README b/doc/README index 6ab73407a4..b665520211 100644 --- a/doc/README +++ b/doc/README @@ -1,12 +1,35 @@ + +This requires Sphinx v1.7 or greater, as well as some add-ons, which can +be installed with: + +pip install sphinx +pip install sphinxcontrib-programoutput +pip install git+https://github.com/esmci/sphinx_rtd_theme.git@version-dropdown-with-fixes + +Check the sphinx version as follows: + +>sphinx-build --version + +The documentation source is stored with the CESM master code base. However, +the built html files are stored separately in the orphan gh-pages branch +and can be viewed from a browser at URL: + +http://escomp.github.io/cesm + +Details for working with the documentation are contained in the following +wiki page: + +https://github.com/ESMCI/cime/wiki/Working-with-Sphinx-and-reStructuredText + +(The procedure is the same for the CESM documentation as for the CIME +documentation.) + Use the following commands to auto-build the html documentation from the main cesm/doc directory: ->make clean ->make html - -The build/html files should be copied to the appropriate release or -development https://github.com/ESCOMP/cesm gh-pages orphan branch -subdirectory and commited to that branch separately. +make clean +make html -Only the doc/source files are stored with the code on the master -branch. \ No newline at end of file +To publish the docs to the orphan gh-pages branch, follow the steps in +https://github.com/ESMCI/cime/wiki/Working-with-Sphinx-and-reStructuredText +to ensure proper versioning of the documentation. diff --git a/doc/source/_static/pop_ver.js b/doc/source/_static/pop_ver.js new file mode 100644 index 0000000000..b8c58658a8 --- /dev/null +++ b/doc/source/_static/pop_ver.js @@ -0,0 +1,37 @@ +$(document).ready(function() { + /* For a URL that looks like + https://blah.github.io/versions/VERSIONFOO/html/bar/index.html, set cur_version_dir to + 'VERSIONFOO' (i.e., the portion of the path following 'versions'). + */ + var proj_end = document.baseURI.indexOf("versions") + 9; + var end = document.baseURI.indexOf("/", proj_end); + var cur_version_dir = document.baseURI.substring(proj_end, end); + var mylist = $("#version-list"); + mylist.empty(); + $.getJSON(version_json_loc, function(data) { + if (data.hasOwnProperty(cur_version_dir)) { + /* First add the current version so that it appears first in the drop-down + menu and starts as the selected element of the menu. If you click on the + current version, you should stay at the current page. + + The conditional around this block should generally be true, but we check it + just in case the current version is missing from the versions.json file for + some reason. + */ + cur_version_name = data[cur_version_dir]; + mylist.append($("