From e568729d9baf0185a7640757e622622457554d78 Mon Sep 17 00:00:00 2001 From: dbhart Date: Wed, 15 Nov 2023 14:44:45 -0700 Subject: [PATCH] Update to TOC --- documentation/_templates/wntr-indices.html | 28 +++++++ documentation/acknowledgements.rst | 2 +- documentation/conf.py | 4 +- documentation/userguide.rst | 91 +++++++--------------- 4 files changed, 60 insertions(+), 65 deletions(-) create mode 100644 documentation/_templates/wntr-indices.html diff --git a/documentation/_templates/wntr-indices.html b/documentation/_templates/wntr-indices.html new file mode 100644 index 000000000..92ef8cb54 --- /dev/null +++ b/documentation/_templates/wntr-indices.html @@ -0,0 +1,28 @@ + diff --git a/documentation/acknowledgements.rst b/documentation/acknowledgements.rst index 62a6b6cef..3812cd8e3 100644 --- a/documentation/acknowledgements.rst +++ b/documentation/acknowledgements.rst @@ -3,7 +3,7 @@ \clearpage Acknowledgements -====================================== +================ WNTR is developed through a collaboration between U.S. Environmental Protection Agency, Sandia National Laboratories, and the open-source community. The U.S. Environmental Protection Agency acknowledges the diff --git a/documentation/conf.py b/documentation/conf.py index d841b1b3a..566f21e96 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -224,7 +224,7 @@ def setup(app): }, ], "use_edit_page_button": False, - "primary_sidebar_end": ["indices.html"], + "primary_sidebar_end": ["wntr-indices"], "show_toc_level": 2, # "secondary_sidebar_items": ["page-toc"], #["page-toc", "edit-this-page", "sourcelink"], "navbar_end": [ "theme-switcher.html", "navbar-icon-links.html",], @@ -360,7 +360,7 @@ def setup(app): # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('userguide', 'wntr.tex', u'WNTR Documentation', + ('index_latex', 'wntr.tex', u'WNTR Documentation', u'', 'howto', 'True'), #u'', 'manual'), ] diff --git a/documentation/userguide.rst b/documentation/userguide.rst index c36320299..be5b7d334 100644 --- a/documentation/userguide.rst +++ b/documentation/userguide.rst @@ -2,44 +2,28 @@ :scale: 10 % :alt: Logo -.. only:: latex +User Guide +========== - WNTR documentation - ================== +The Water Network Tool for Resilience (WNTR) is an EPANET compatible Python package +designed to simulate and analyze resilience of water distribution networks. -.. only:: html +US EPA Disclaimer +----------------- - User Guide - ========== +The U.S. Environmental Protection Agency through its Office of Research and Development funded and collaborated +in the research described here under an Interagency Agreement with the Department of Energy's Sandia National Laboratories. +It has been subjected to the Agency's review and has been approved for publication. Note that approval does not signify that +the contents necessarily reflect the views of the Agency. Mention of trade names products, or services does not convey official +EPA approval, endorsement, or recommendation. - The Water Network Tool for Resilience (WNTR) is an EPANET compatible Python package - designed to simulate and analyze resilience of water distribution networks. - US EPA Disclaimer - ----------------- +Sandia Funding Statement +------------------------ - The U.S. Environmental Protection Agency through its Office of Research and Development funded and collaborated - in the research described here under an Interagency Agreement with the Department of Energy's Sandia National Laboratories. - It has been subjected to the Agency's review and has been approved for publication. Note that approval does not signify that - the contents necessarily reflect the views of the Agency. Mention of trade names products, or services does not convey official - EPA approval, endorsement, or recommendation. - - - Sandia Funding Statement - ------------------------ - - Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and - Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the - U.S. Department of Energy's National Nuclear Security Administration under contract DE-NA-0003525. - -.. only:: latex - - .. toctree:: - :maxdepth: 1 - - disclaimer - acronyms - acknowledgements +Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and +Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the +U.S. Department of Energy's National Nuclear Security Administration under contract DE-NA-0003525. .. toctree:: :maxdepth: 1 @@ -87,39 +71,22 @@ gis advancedsim -.. only:: latex - - .. toctree:: - :maxdepth: 1 - :hidden: - :caption: Backmatter - - license - whatsnew - users - developers - reference - -.. only:: html - - .. toctree:: - :maxdepth: 1 - :hidden: - :caption: Backmatter +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: Backmatter - license - whatsnew - developers - acronyms - reference + license + whatsnew + developers - Citing WNTR - ----------------- - To cite WNTR, use one of the following references: +Citing WNTR +----------------- +To cite WNTR, use one of the following references: - * Klise, K.A., Hart, D.B., Bynum, M., Hogge, J., Haxton, T., Murray, R., Burkhardt, J. (2020). Water Network Tool for Resilience (WNTR) User Manual: Version 0.2.3. U.S. EPA Office of Research and Development, Washington, DC, EPA/600/R-20/185, 82p. +* Klise, K.A., Hart, D.B., Bynum, M., Hogge, J., Haxton, T., Murray, R., Burkhardt, J. (2020). Water Network Tool for Resilience (WNTR) User Manual: Version 0.2.3. U.S. EPA Office of Research and Development, Washington, DC, EPA/600/R-20/185, 82p. - * Klise, K.A., Murray, R., Haxton, T. (2018). An overview of the Water Network Tool for Resilience (WNTR), In Proceedings of the 1st International WDSA/CCWI Joint Conference, Kingston, Ontario, Canada, July 23-25, 075, 8p. +* Klise, K.A., Murray, R., Haxton, T. (2018). An overview of the Water Network Tool for Resilience (WNTR), In Proceedings of the 1st International WDSA/CCWI Joint Conference, Kingston, Ontario, Canada, July 23-25, 075, 8p. - * Klise, K.A., Bynum, M., Moriarty, D., Murray, R. (2017). A software framework for assessing the resilience of drinking water systems to disasters with an example earthquake case study, Environmental Modelling and Software, 95, 420-431, doi: 10.1016/j.envsoft.2017.06.022 +* Klise, K.A., Bynum, M., Moriarty, D., Murray, R. (2017). A software framework for assessing the resilience of drinking water systems to disasters with an example earthquake case study, Environmental Modelling and Software, 95, 420-431, doi: 10.1016/j.envsoft.2017.06.022