Skip to content

Commit

Permalink
Merge pull request #11 from JSchripsema-IDM/dev_branch_to_merge_back
Browse files Browse the repository at this point in the history
updated Sphinx config to correctly apply css, corrected typos in .git…
  • Loading branch information
jonathanhhb authored Sep 28, 2023
2 parents 8fe80d2 + efd6edd commit 09a7fcd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ instance/

# Sphinx documentation
docs/_build/
docs/emodpy-typhoid*.rst
docs/emodpy_typhoid*.rst
docs/modules.rst

# PyBuilder
Expand Down
32 changes: 22 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,27 @@
'sphinx_copybutton',
'sphinx.ext.intersphinx',
'sphinxext.remoteliteralinclude',
'myst_parser',
'sphinx_search.extension'
'myst_parser', # source files written in MD or RST
'sphinx_search.extension', # search across entire IDM docs domain
'sphinx.ext.viewcode' # link to view source code
]

myst_enable_extensions = [
"amsmath",
"attrs_inline",
"colon_fence",
"deflist",
"dollarmath",
"fieldlist",
"html_admonition",
"html_image",
"linkify",
"replacements",
"smartquotes",
"strikethrough",
"substitution",
"tasklist",
]
plantuml = 'plantweb'

autodoc_default_options = {
Expand Down Expand Up @@ -208,18 +225,13 @@
# 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']

html_context = {
'css_files': [
'_static/theme_overrides.css',
'_static/copy_button.css'
]
}
html_js_files = ['show_block_by_os.js']
html_static_path = ['_static']

html_css_files = ['theme_overrides.css']

html_js_files = ['show_block_by_os.js']


# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
2 changes: 1 addition & 1 deletion emodpy_typhoid/demographics/TyphoidDemographics.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ def from_csv( pop_filename_in, site="No_Site", min_node_pop = 0 ):
site: A string to identify the country, village, or trial site.
Returns:
A :py:class:`~emodpy_malaria.demographics.MalariaDemographics` instance.
A :py:class:`~emodpy_typhoid.demographics.MalariaDemographics` instance.
"""
typhoid_demog = Demog.from_csv( pop_filename_in )
nodes = []
Expand Down

0 comments on commit 09a7fcd

Please sign in to comment.