Skip to content

Commit

Permalink
Try pydata-sphinx-theme for docs (#16)
Browse files Browse the repository at this point in the history
* try pydata-sphinx-theme

* theme settings and reduced dataframe font
  • Loading branch information
scottyhq authored Nov 1, 2024
1 parent 5b6ff32 commit c6892d2
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 85 deletions.
4 changes: 4 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/* Make default pandas table font smaller */
div.cell_output table {
font-size: 0.8em;
}
39 changes: 26 additions & 13 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
from __future__ import annotations

import importlib.metadata
from typing import Any

project = "coincident"
copyright = "2024, Scott Henderson"
Expand Down Expand Up @@ -34,25 +33,39 @@
".venv",
]

html_theme = "furo"
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme_options: dict[str, Any] = {
"footer_icons": [
html_theme = "pydata_sphinx_theme"
html_theme_options = {
"use_edit_page_button": True,
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/uw-cryo/coincident",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
</svg>
""",
"class": "",
"icon": "fa-brands fa-github",
"type": "fontawesome",
},
],
"source_repository": "https://github.com/uw-cryo/coincident",
"source_branch": "main",
"source_directory": "docs/",
}
html_title = "Coincident"
html_context = {
"github_user": "uw-cryo",
"github_repo": "coincident",
"github_version": "main",
"doc_path": "docs",
}

# remove sidebar, see GH issue #82
html_css_files = [
"custom.css",
]

html_static_path = ["_static"]

# NOTE: consider adding back in once for distinct sections (user guide, examples, API reference)
# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#primary-sidebar-left
html_sidebars = {"**": []}

myst_enable_extensions = [
"colon_fence",
Expand Down
Loading

0 comments on commit c6892d2

Please sign in to comment.