From 1e51ba21dd00621c3ba39fa4a75163993ed31c18 Mon Sep 17 00:00:00 2001 From: Jonathan Bloedow Date: Thu, 28 Sep 2023 07:57:15 -0700 Subject: [PATCH] Changed some remaining malaria references (from template) to typhiod. --- docs/conf.py | 14 +++++++------- docs/index.rst | 6 +++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 87daa25..bf7f837 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ else: subprocess.check_output(["make.bat", "generate-api"], cwd=os.path.dirname(os.path.abspath(__file__))) -# Rename "emodpy-malaria" to "API reference" +# Rename "emodpy-typhoid" to "API reference" filename = 'modules.rst' # This must match the Makefile with open(filename) as f: # Read existing file lines = f.readlines() @@ -310,7 +310,7 @@ # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'emodpy-malaria' +htmlhelp_basename = 'emodpy-typhoid' # -- Options for LaTeX output --------------------------------------------- @@ -336,7 +336,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'emodpy-malaria-docs.tex', u'emodpy-malaria', + (master_doc, 'emodpy-typhoid-docs.tex', u'emodpy-typhoid', u'Institute for Disease Modeling', 'manual'), ] @@ -378,7 +378,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'emodpy-malaria-docs', u'emodpy-malaria', + (master_doc, 'emodpy-typhoid-docs', u'emodpy-typhoid', [author], 1) ] @@ -392,8 +392,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'emodpy-malaria-docs', u'emodpy-malaria', - author, 'Institute for Disease Modeling', 'How to use emodpy for malaria simulations.', + (master_doc, 'emodpy-typhoid-docs', u'emodpy-typhoid', + author, 'Institute for Disease Modeling', 'How to use emodpy for typhoid simulations.', 'Miscellaneous'), ] @@ -420,6 +420,6 @@ 'emod_api': ('https://docs.idmod.org/projects/emod-api/en/latest/', None), 'emodpy': ('https://docs.idmod.org/projects/emodpy/en/latest/', None), 'idmtools': ('https://docs.idmod.org/projects/idmtools/en/latest/', None), - 'emod-malaria': ('https://docs.idmod.org/projects/emod-malaria/en/latest/', None), + 'emod-typhoid': ('https://docs.idmod.org/projects/emod-typhoid/en/latest/', None), 'pycomps': ('https://docs.idmod.org/projects/pycomps/en/latest/', None) } \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index c2faa97..677e143 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,13 +3,13 @@ ============================== |EMODPY_typhoid| is a collection of Python scripts and utilities created to -streamline user interactions with |EMOD_s| and |IT_s| for modeling malaria. +streamline user interactions with |EMOD_s| and |IT_s| for modeling typhoid. Much of the functionality is inherited from the :doc:`emod_api:emod_api` and :doc:`emodpy:emodpy`. Additional information about how to use |IT_s| can be found in -:doc:`idmtools:index`. Additional information about |EMOD_s| malaria -parameters can be found in :doc:`emod-malaria:parameter-overview`. +:doc:`idmtools:index`. Additional information about |EMOD_s| typhoid +parameters can be found in :doc:`emod-typhoid:parameter-overview`. See :doc:`idmtools:index` for a diagram showing how |IT_s| and each of the related packages are used in an end-to-end workflow using |EMOD_s| as the