Skip to content

Commit

Permalink
Changed some remaining malaria references (from template) to typhiod.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Bloedow committed Sep 28, 2023
1 parent b50a01e commit 1e51ba2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -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 ---------------------------------------------

Expand All @@ -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'),
]

Expand Down Expand Up @@ -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)
]

Expand All @@ -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'),
]

Expand All @@ -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)
}
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1e51ba2

Please sign in to comment.