-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add initial varsion of doc directory
- Loading branch information
1 parent
386e163
commit 53676ef
Showing
8 changed files
with
269 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,2 @@ | ||
# Ignore auto-generated documentation for the addendum | ||
build |
This file contains 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,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = sphinx-build | ||
SPHINXPROJ = CMEPS | ||
SOURCEDIR = source | ||
BUILDDIR = build | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
This file contains 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,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($("<option>", {value: document.baseURI, text: cur_version_name})); | ||
} | ||
// Now add the other versions | ||
$.each(data, function(version_dir, version_name) { | ||
if (version_dir != cur_version_dir) { | ||
/* If you click on a different version, you should go to the root of the | ||
documentation for that version. This assumes paths like | ||
https://blah.github.io/versions/VERSIONFOO/html/bar/index.html. So we | ||
need to go up two levels from the URL_ROOT (html) to then go back down | ||
into the appropriate version's html directory. | ||
*/ | ||
mylist.append($("<option>", {value: DOCUMENTATION_OPTIONS.URL_ROOT + '../../' + version_dir + '/html', text: version_name})); | ||
} | ||
}); | ||
}); | ||
}); |
This file contains 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,5 @@ | ||
{% extends "!footer.html" %} | ||
{% block extrafooter %} | ||
{{ super() }} | ||
<script>var version_json_loc = "{{ pathto('../../versions.json', 1) }}";</script> | ||
{% endblock %} |
This file contains 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,3 @@ | ||
{% extends "!layout.html" %} | ||
|
||
{% set script_files = script_files + ["_static/pop_ver.js"] %} |
This file contains 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,179 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# on documentation build configuration file, created by | ||
# sphinx-quickstart on Tue Jan 31 19:46:36 2017. | ||
# | ||
# This file is execfile()d with the current directory set to its | ||
# containing dir. | ||
# | ||
# Note that not all possible configuration values are present in this | ||
# autogenerated file. | ||
# | ||
# All configuration values have a default; values that are commented out | ||
# serve to show the default. | ||
|
||
# If extensions (or modules to document with autodoc) are in another directory, | ||
# add these directories to sys.path here. If the directory is relative to the | ||
# documentation root, use os.path.abspath to make it absolute, like shown here. | ||
# | ||
import os | ||
import sys | ||
# Note that we need a specific version of sphinx_rtd_theme. This can be obtained with: | ||
# pip install git+https://github.com/esmci/sphinx_rtd_theme.git@version-dropdown-with-fixes | ||
import sphinx_rtd_theme | ||
|
||
# -- General configuration ------------------------------------------------ | ||
|
||
# If your documentation needs a minimal Sphinx version, state it here. | ||
# | ||
# needs_sphinx = '1.0' | ||
|
||
# Add any Sphinx extension module names here, as strings. They can be | ||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
# ones. | ||
extensions = [ | ||
'sphinx.ext.todo', | ||
'sphinx.ext.coverage', | ||
'sphinx.ext.githubpages', | ||
'sphinx.ext.autodoc', | ||
'sphinx.ext.autosummary', | ||
'sphinx.ext.viewcode', | ||
'sphinx.ext.todo', | ||
'sphinxcontrib.programoutput' | ||
] | ||
todo_include_todos=True | ||
|
||
# Add any paths that contain templates here, relative to this directory. | ||
templates_path = ['_templates'] | ||
|
||
# The suffix(es) of source filenames. | ||
# You can specify multiple suffix as a list of string: | ||
# | ||
# source_suffix = ['.rst', '.md'] | ||
source_suffix = '.rst' | ||
|
||
# The master toctree document. | ||
master_doc = 'index' | ||
|
||
# General information about the project. | ||
project = u'CMEPS' | ||
copyright = u'2020, U.S. National Science Foundation' | ||
author = u'Staff of the NSF/CESM project and NOAA/EMC' | ||
|
||
# The version info for the project you're documenting, acts as replacement for | ||
# |version| and |release|, also used in various other places throughout the | ||
# built documents. | ||
# | ||
# The short X.Y version. | ||
version = u'master' | ||
# The full version, including alpha/beta/rc tags. | ||
release = u'master' | ||
|
||
# The language for content autogenerated by Sphinx. Refer to documentation | ||
# for a list of supported languages. | ||
# | ||
# This is also used if you do content translation via gettext catalogs. | ||
# Usually you set "language" from the command line for these cases. | ||
language = None | ||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
# This patterns also effect to html_static_path and html_extra_path | ||
exclude_patterns = [] | ||
|
||
# The name of the Pygments (syntax highlighting) style to use. | ||
pygments_style = 'sphinx' | ||
|
||
# If true, `todo` and `todoList` produce output, else they produce nothing. | ||
todo_include_todos = True | ||
|
||
# -- Options for HTML output ---------------------------------------------- | ||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for | ||
# a list of builtin themes. | ||
# | ||
html_theme = 'sphinx_rtd_theme' | ||
|
||
# Theme options are theme-specific and customize the look and feel of a theme | ||
# further. For a list of options available for each theme, see the | ||
# documentation. | ||
# | ||
#html_theme_options = {"stickysidebar": "true"} | ||
|
||
# The 'versions' option needs to have at least two versions to work, but it doesn't need | ||
# to have all versions: others will be added dynamically. Note that this maps from version | ||
# names to html links. The current version can link to the current location (i.e., do | ||
# nothing). For the other version, we just add a place-holder; its name and value are | ||
# unimportant because these versions will get replaced dynamically. | ||
html_theme_options = {} | ||
html_theme_options['versions'] = {version: ''} | ||
html_theme_options['versions']['[placeholder]'] = '' | ||
|
||
# Add any paths that contain custom static files (such as style sheets) here, | ||
# relative to this directory. They are copied after the builtin static files, | ||
# so a file named "default.css" will overwrite the builtin "default.css". | ||
html_static_path = ['_static'] | ||
|
||
# -- Options for HTMLHelp output ------------------------------------------ | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = 'ondoc' | ||
|
||
|
||
# -- Options for LaTeX output --------------------------------------------- | ||
|
||
latex_elements = { | ||
# The paper size ('letterpaper' or 'a4paper'). | ||
# | ||
# 'papersize': 'letterpaper', | ||
|
||
# The font size ('10pt', '11pt' or '12pt'). | ||
# | ||
# 'pointsize': '10pt', | ||
|
||
# Additional stuff for the LaTeX preamble. | ||
# | ||
# 'preamble': '', | ||
|
||
# Latex figure (float) alignment | ||
# | ||
# 'figure_align': 'htbp', | ||
} | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, | ||
# author, documentclass [howto, manual, or own class]). | ||
latex_documents = [ | ||
(master_doc, 'on.tex', u'on Documentation', | ||
u'Staff of the NCAR and NOAA/EMC', 'manual'), | ||
] | ||
|
||
|
||
# -- Options for manual page output --------------------------------------- | ||
|
||
# One entry per manual page. List of tuples | ||
# (source start file, name, description, authors, manual section). | ||
man_pages = [ | ||
(master_doc, 'on', u'on Documentation', | ||
[author], 1) | ||
] | ||
|
||
|
||
# -- Options for Texinfo output ------------------------------------------- | ||
|
||
# Grouping the document tree into Texinfo files. List of tuples | ||
# (source start file, target name, title, author, | ||
# dir menu entry, description, category) | ||
texinfo_documents = [ | ||
(master_doc, 'on', u'on Documentation', | ||
author, 'on', 'One line description of project.', | ||
'Miscellaneous'), | ||
] | ||
|
||
# -- Options for pdf output ------------------------------------------------- | ||
|
||
pdf_documents = [ | ||
(master_doc, | ||
u'CMEPS_Users_Guide', | ||
u'CMEPS Users Guide (PDF)',) | ||
] |
This file contains 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,19 @@ | ||
.. on documentation master file, created by | ||
sphinx-quickstart on Mon May 18 11:50:23 2020. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
CMEPS documentation | ||
=================== | ||
The Community Mediator for Earth Prediction Systems (CMEPS) is a | ||
NUOPC-compliant Mediator component used for coupling Earth system | ||
model components. It is currently being used in NCAR's Community | ||
Earth System Model (CESM) and NOAA's subseasonal-to-seasonal | ||
coupled system. | ||
|
||
Table of contents | ||
----------------- | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
introduction.rst |
This file contains 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,4 @@ | ||
Introduction | ||
============ | ||
|
||
Content to go here: |