Merge pull request #14 from NRCan/web_manual

Removed test configurations from config.py
NRCan · Oct 18, 2021 · 95da8ed · 95da8ed
2 parents b4a8be9 + 9a7bdfd
commit 95da8ed
Show file tree

Hide file tree

Showing 124 changed files with 2,550 additions and 81 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,84 +58,4 @@
 # 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']
-
-############################
-# SETUP THE RTD LOWER-LEFT #
-############################
-try:
-   html_context
-except NameError:
-   html_context = dict()
-html_context['display_lower_left'] = True
-
-templates_path = ['_templates']
-
-if 'REPO_NAME' in os.environ:
-   REPO_NAME = os.environ['REPO_NAME']
-else:
-   REPO_NAME = ''
-
-# SET CURRENT_LANGUAGE
-if 'current_language' in os.environ:
-   # get the current_language env var set by buildDocs.sh
-   current_language = os.environ['current_language']
-else:
-   # the user is probably doing `make html`
-   # set this build's current language to english
-   current_language = 'en'
-
-# tell the theme which language to we're currently building
-html_context['current_language'] = current_language
-
-# SET CURRENT_VERSION
-# from git import Repo
-# repo = Repo( search_parent_directories=True )
-
-if 'current_version' in os.environ:
-   # get the current_version env var set by buildDocs.sh
-   current_version = os.environ['current_version']
-else:
-   # the user is probably doing `make html`
-   # set this build's current version by looking at the branch
-  #  current_version = repo.active_branch.name
-   current_version = version
-
-# tell the theme which version we're currently on ('current_version' affects
-# the lower-left rtd menu and 'version' affects the logo-area version)
-html_context['current_version'] = current_version
-html_context['version'] = current_version
-
-# POPULATE LINKS TO OTHER LANGUAGES
-html_context['languages'] = [ ('en', '/' +REPO_NAME+ '/en/' +current_version+ '/') ]
-
-languages = [lang.name for lang in os.scandir('locales') if lang.is_dir()]
-for lang in languages:
-   html_context['languages'].append( (lang, '/' +REPO_NAME+ '/' +lang+ '/' +current_version+ '/') )
-
-# POPULATE LINKS TO OTHER VERSIONS
-html_context['versions'] = list()
-
-versions = [branch for branch in version_list]
-for version in versions:
-   html_context['versions'].append( (version, '/' +REPO_NAME+ '/'  +current_language+ '/' +version+ '/') )
-
-# POPULATE LINKS TO OTHER FORMATS/DOWNLOADS
-
-# settings for creating PDF with rinoh
-rinoh_documents = [(
- master_doc,
- 'target',
- project+ ' Documentation',
- '© ' +copyright,
-)]
-today_fmt = "%B %d, %Y"
-
-# settings for EPUB
-epub_basename = 'target'
-
-html_context['downloads'] = list()
-html_context['downloads'].append( ('pdf', '/' +REPO_NAME+ '/' +current_language+ '/' +current_version+ '/' +project+ '-docs_' +current_language+ '_' +current_version+ '.pdf') )
-
-html_context['downloads'].append( ('epub', '/' +REPO_NAME+ '/' +current_language+ '/' +current_version+ '/' +project+ '-docs_' +current_language+ '_' +current_version+ '.epub') )
-
+html_static_path = ['_static']
diff --git a/docs/source/_static/NRCan_logo.jpg b/docs/source/_static/NRCan_logo.jpg
diff --git a/docs/source/_static/add_connections_image.jpg b/docs/source/_static/add_connections_image.jpg
diff --git a/docs/source/_static/algorithm_summary_1.jpg b/docs/source/_static/algorithm_summary_1.jpg
diff --git a/docs/source/_static/algorithm_summary_2.jpg b/docs/source/_static/algorithm_summary_2.jpg
diff --git a/docs/source/_static/app_workflow_build_model.jpg b/docs/source/_static/app_workflow_build_model.jpg
diff --git a/docs/source/_static/app_wrkflw_3_1_risk_ecp.jpg b/docs/source/_static/app_wrkflw_3_1_risk_ecp.jpg
diff --git a/docs/source/_static/app_wrkflw_3_2_vuln.jpg b/docs/source/_static/app_wrkflw_3_2_vuln.jpg
diff --git a/docs/source/_static/app_wrkflw_3_3_1_wrkflw.jpg b/docs/source/_static/app_wrkflw_3_3_1_wrkflw.jpg
diff --git a/docs/source/_static/app_wrkflw_3_3_2_event_relations.jpg b/docs/source/_static/app_wrkflw_3_3_2_event_relations.jpg
diff --git a/docs/source/_static/build_image.jpg b/docs/source/_static/build_image.jpg
diff --git a/docs/source/_static/green_dot_image.jpg b/docs/source/_static/green_dot_image.jpg
diff --git a/docs/source/_static/horizontal_line_image.jpg b/docs/source/_static/horizontal_line_image.jpg
diff --git a/docs/source/_static/installation_image.jpg b/docs/source/_static/installation_image.jpg
diff --git a/docs/source/_static/intro_1_4_conrol_files.jpg b/docs/source/_static/intro_1_4_conrol_files.jpg
diff --git a/docs/source/_static/red_diamond_image.jpg b/docs/source/_static/red_diamond_image.jpg
diff --git a/docs/source/_static/run_image.jpg b/docs/source/_static/run_image.jpg
diff --git a/docs/source/_static/styling_manager_image.jpg b/docs/source/_static/styling_manager_image.jpg
diff --git a/docs/source/_static/toolsets_5_1_3_haz_sampler.jpg b/docs/source/_static/toolsets_5_1_3_haz_sampler.jpg
diff --git a/docs/source/_static/toolsets_5_1_3_hazsamp_ras_prep.jpg b/docs/source/_static/toolsets_5_1_3_hazsamp_ras_prep.jpg
diff --git a/docs/source/_static/toolsets_5_1_5_conditionalp.jpg b/docs/source/_static/toolsets_5_1_5_conditionalp.jpg
diff --git a/docs/source/_static/toolsets_5_2_3_eq_1.jpg b/docs/source/_static/toolsets_5_2_3_eq_1.jpg
diff --git a/docs/source/_static/toolsets_5_2_3_eq_2.jpg b/docs/source/_static/toolsets_5_2_3_eq_2.jpg
diff --git a/docs/source/_static/toolsets_5_2_3_eq_3.jpg b/docs/source/_static/toolsets_5_2_3_eq_3.jpg
diff --git a/docs/source/_static/toolsets_5_2_3_sayers.jpg b/docs/source/_static/toolsets_5_2_3_sayers.jpg
diff --git a/docs/source/_static/toolsets_5_2_parameter_summary.jpg b/docs/source/_static/toolsets_5_2_parameter_summary.jpg
diff --git a/docs/source/_static/toolsets_5_4_1_fig_5_7.jpg b/docs/source/_static/toolsets_5_4_1_fig_5_7.jpg
diff --git a/docs/source/_static/toolsets_5_4_1_fig_5_8.jpg b/docs/source/_static/toolsets_5_4_1_fig_5_8.jpg
diff --git a/docs/source/_static/toolsets_5_4_1_fig_5_8_2.jpg b/docs/source/_static/toolsets_5_4_1_fig_5_8_2.jpg
diff --git a/docs/source/_static/toolsets_5_4_3_img.jpg b/docs/source/_static/toolsets_5_4_3_img.jpg
diff --git a/docs/source/_static/toolsets_5_4_4_img.jpg b/docs/source/_static/toolsets_5_4_4_img.jpg
diff --git a/docs/source/_static/toolsets_5_4_4_layer_styling.jpg b/docs/source/_static/toolsets_5_4_4_layer_styling.jpg
diff --git a/docs/source/_static/toolsets_model_5_2_2_impacts.jpg b/docs/source/_static/toolsets_model_5_2_2_impacts.jpg
diff --git a/docs/source/_static/toolsets_model_fic_5_3_4_legend.jpg b/docs/source/_static/toolsets_model_fic_5_3_4_legend.jpg
diff --git a/docs/source/_static/toolsets_model_fig_5_3_4.jpg b/docs/source/_static/toolsets_model_fig_5_3_4.jpg
diff --git a/docs/source/_static/toolsets_model_fig_5_4.jpg b/docs/source/_static/toolsets_model_fig_5_4.jpg
diff --git a/docs/source/_static/toolsets_model_fig_5_5.jpg b/docs/source/_static/toolsets_model_fig_5_5.jpg
diff --git a/docs/source/_static/toolsets_model_fig_5_6.jpg b/docs/source/_static/toolsets_model_fig_5_6.jpg
diff --git a/docs/source/_static/toolsets_model_table_5_12_eq_1.jpg b/docs/source/_static/toolsets_model_table_5_12_eq_1.jpg
diff --git a/docs/source/_static/toolsets_model_table_5_12_eq_2.jpg b/docs/source/_static/toolsets_model_table_5_12_eq_2.jpg
diff --git a/docs/source/_static/toolsets_model_table_5_12_eq_3.jpg b/docs/source/_static/toolsets_model_table_5_12_eq_3.jpg
diff --git a/docs/source/_static/tutorials_6_10_1_img_1.jpg b/docs/source/_static/tutorials_6_10_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_10_1_img_2.jpg b/docs/source/_static/tutorials_6_10_1_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_10_1_img_3.jpg b/docs/source/_static/tutorials_6_10_1_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_10_1_img_4.jpg b/docs/source/_static/tutorials_6_10_1_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_10_1_img_5.jpg b/docs/source/_static/tutorials_6_10_1_img_5.jpg
diff --git a/docs/source/_static/tutorials_6_10_2_img_1.jpg b/docs/source/_static/tutorials_6_10_2_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_10_2_img_2.jpg b/docs/source/_static/tutorials_6_10_2_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_10_2_img_3.jpg b/docs/source/_static/tutorials_6_10_2_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_11_1_img_1.jpg b/docs/source/_static/tutorials_6_11_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_11_1_img_2.jpg b/docs/source/_static/tutorials_6_11_1_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_11_1_img_3.jpg b/docs/source/_static/tutorials_6_11_1_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_11_1_img_4.jpg b/docs/source/_static/tutorials_6_11_1_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_11_2_img_1.jpg b/docs/source/_static/tutorials_6_11_2_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_11_3_img_1.jpg b/docs/source/_static/tutorials_6_11_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_11_3_img_2.jpg b/docs/source/_static/tutorials_6_11_3_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_11_img_1.jpg b/docs/source/_static/tutorials_6_11_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_11_img_2.jpg b/docs/source/_static/tutorials_6_11_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_11_img_3.jpg b/docs/source/_static/tutorials_6_11_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_1_1_table.jpg b/docs/source/_static/tutorials_6_1_1_table.jpg
diff --git a/docs/source/_static/tutorials_6_1_1_tiff.jpg b/docs/source/_static/tutorials_6_1_1_tiff.jpg
diff --git a/docs/source/_static/tutorials_6_1_2_img_1.jpg b/docs/source/_static/tutorials_6_1_2_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_1_2_img_2.jpg b/docs/source/_static/tutorials_6_1_2_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_1_2_img_3.jpg b/docs/source/_static/tutorials_6_1_2_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_1_2_img_4.jpg b/docs/source/_static/tutorials_6_1_2_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_1_2_img_5.jpg b/docs/source/_static/tutorials_6_1_2_img_5.jpg
diff --git a/docs/source/_static/tutorials_6_1_2_img_6.jpg b/docs/source/_static/tutorials_6_1_2_img_6.jpg
diff --git a/docs/source/_static/tutorials_6_1_3_img_1.jpg b/docs/source/_static/tutorials_6_1_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_1_3_img_2.jpg b/docs/source/_static/tutorials_6_1_3_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_1_4_img_1.jpg b/docs/source/_static/tutorials_6_1_4_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_1_4_img_2.jpg b/docs/source/_static/tutorials_6_1_4_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_1_4_img_3.jpg b/docs/source/_static/tutorials_6_1_4_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_1_4_img_4.jpg b/docs/source/_static/tutorials_6_1_4_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_2_1_img_1.jpg b/docs/source/_static/tutorials_6_2_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_2_2_img_1.jpg b/docs/source/_static/tutorials_6_2_2_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_2_2_img_2.jpg b/docs/source/_static/tutorials_6_2_2_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_2_2_img_3.jpg b/docs/source/_static/tutorials_6_2_2_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_2_2_img_4.jpg b/docs/source/_static/tutorials_6_2_2_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_2_2_img_5.jpg b/docs/source/_static/tutorials_6_2_2_img_5.jpg
diff --git a/docs/source/_static/tutorials_6_2_3_img_1.jpg b/docs/source/_static/tutorials_6_2_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_2_3_img_2.jpg b/docs/source/_static/tutorials_6_2_3_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_2_3_img_3.jpg b/docs/source/_static/tutorials_6_2_3_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_2_4_img_1.jpg b/docs/source/_static/tutorials_6_2_4_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_2_4_img_2.jpg b/docs/source/_static/tutorials_6_2_4_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_2_4_img_3.jpg b/docs/source/_static/tutorials_6_2_4_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_2_4_img_4.jpg b/docs/source/_static/tutorials_6_2_4_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_2_4_img_5.jpg b/docs/source/_static/tutorials_6_2_4_img_5.jpg
diff --git a/docs/source/_static/tutorials_6_3_1_img_1.jpg b/docs/source/_static/tutorials_6_3_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_3_1_img_2.jpg b/docs/source/_static/tutorials_6_3_1_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_3_1_img_3.jpg b/docs/source/_static/tutorials_6_3_1_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_3_3_img_1.jpg b/docs/source/_static/tutorials_6_3_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_3_img_1.jpg b/docs/source/_static/tutorials_6_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_4_1_img_1.jpg b/docs/source/_static/tutorials_6_4_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_4_3_img_1.jpg b/docs/source/_static/tutorials_6_4_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_4_3_img_2.jpg b/docs/source/_static/tutorials_6_4_3_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_4_3_img_3.jpg b/docs/source/_static/tutorials_6_4_3_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_4_3_img_4.jpg b/docs/source/_static/tutorials_6_4_3_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_5_1_img_1.jpg b/docs/source/_static/tutorials_6_5_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_5_1_img_2.jpg b/docs/source/_static/tutorials_6_5_1_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_5_2_img_1.jpg b/docs/source/_static/tutorials_6_5_2_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_5_2_img_2.jpg b/docs/source/_static/tutorials_6_5_2_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_5_2_img_3.jpg b/docs/source/_static/tutorials_6_5_2_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_5_2_img_4.jpg b/docs/source/_static/tutorials_6_5_2_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_5_3_img_1.jpg b/docs/source/_static/tutorials_6_5_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_6_img_1.jpg b/docs/source/_static/tutorials_6_6_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_6_img_2.jpg b/docs/source/_static/tutorials_6_6_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_6_img_3.jpg b/docs/source/_static/tutorials_6_6_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_6_img_4.jpg b/docs/source/_static/tutorials_6_6_img_4.jpg
diff --git a/docs/source/_static/tutorials_6_6_img_5.jpg b/docs/source/_static/tutorials_6_6_img_5.jpg
diff --git a/docs/source/_static/tutorials_6_6_img_6.jpg b/docs/source/_static/tutorials_6_6_img_6.jpg
diff --git a/docs/source/_static/tutorials_6_8_1_img_1.jpg b/docs/source/_static/tutorials_6_8_1_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_8_1_img_2.jpg b/docs/source/_static/tutorials_6_8_1_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_8_1_img_3.jpg b/docs/source/_static/tutorials_6_8_1_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_8_2_img_1.jpg b/docs/source/_static/tutorials_6_8_2_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_8_3_img_1.jpg b/docs/source/_static/tutorials_6_8_3_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_8_3_img_2.jpg b/docs/source/_static/tutorials_6_8_3_img_2.jpg
diff --git a/docs/source/_static/tutorials_6_8_3_img_3.jpg b/docs/source/_static/tutorials_6_8_3_img_3.jpg
diff --git a/docs/source/_static/tutorials_6_8_img_1.jpg b/docs/source/_static/tutorials_6_8_img_1.jpg
diff --git a/docs/source/_static/tutorials_6_9_img_1.jpg b/docs/source/_static/tutorials_6_9_img_1.jpg
diff --git a/docs/source/_static/visual_image.jpg b/docs/source/_static/visual_image.jpg
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,67 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'CanFlood'
+copyright = '2021, Seth Bryant'
+author = 'Seth Bryant'
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = '_static/NRCan_logo.jpg'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+version = '1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.githubpages'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- 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'
+
+# 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']
+
+# 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 = "en"
diff --git a/docs/source/includeme.rst b/docs/source/includeme.rst
@@ -0,0 +1 @@
+.. include:: ../../README.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,12 @@
+Documentation for CanFlood |version|
+--------------------------------
+
+Please have a look into the documents below.
+
+.. toctree::
+   :maxdepth: 2
+
+   Table of Contents <table_of_contents/index>
+
+
+   includeme