Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve docs layout #28

Merged
merged 1 commit into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,20 @@
]

templates_path = ['_templates']
exclude_patterns = []

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

source_suffix = [".rst"]

html_sidebars = {
"**": [
"relations.html", # needs 'show_related': True theme option to display
"searchbox.html",
]
}

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down
8 changes: 4 additions & 4 deletions docs/source/example_model_run_HBV.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"id": "111bc65b-8299-43ba-95fd-e92df6b92707",
"metadata": {},
"source": [
"#### set up paths"
"## set up paths"
]
},
{
Expand Down Expand Up @@ -86,7 +86,7 @@
"id": "4787c692-3f9c-402b-9b48-93daeeb47926",
"metadata": {},
"source": [
"#### add parameter info"
"## add parameter info"
]
},
{
Expand Down Expand Up @@ -267,7 +267,7 @@
"id": "1e320191-4ee4-4535-94f3-05e5afef96e2",
"metadata": {},
"source": [
"# Running model"
"## Running model"
]
},
{
Expand Down Expand Up @@ -308,7 +308,7 @@
"id": "9b88262e-c750-4f8e-a602-50c404969690",
"metadata": {},
"source": [
"# Process results:"
"## Process results:"
]
},
{
Expand Down
Loading