Skip to content

Commit

Permalink
Improve documentation. Add favicon and hide sidebar from installation…
Browse files Browse the repository at this point in the history
… page
  • Loading branch information
pablomm committed Aug 21, 2024
1 parent 152b780 commit ef2223a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -187,4 +187,5 @@ autosummary/

# Include DMF env module
!dmf/env/
!docs/assets/*.svg
!docs/assets/*.svg
!docs/assets/*.png
Binary file added docs/assets/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,11 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "pydata_sphinx_theme"
html_favicon = "https://brainvitge.org/website/wp-content/themes/brainvitge/favicon.png"
#html_logo = "https://raw.githubusercontent.com/memory-formation/.github/main/logos/brainvitge.png"
html_favicon = "assets/favicon.png"
html_logo = "assets/dmf-utils-inline.svg"
html_logo_dark = "assets/dmf-utils-inline-dark.svg"
html_theme_options = {
"github_url": "https://github.com/memory-formation/dmf-utils",
# "navbar_start": ["navbar-logo"],
"logo": {
"text": "dmf-utils",
},
Expand Down Expand Up @@ -96,3 +94,6 @@
"doc_path": "docs",
}

html_sidebars = {
'installation': []
}

0 comments on commit ef2223a

Please sign in to comment.