Skip to content

Commit

Permalink
update docs theme to pydata-sphinx-theme (#138)
Browse files Browse the repository at this point in the history
Fixes #133

Authors:
  - Benjamin Zaitlen (https://github.com/quasiben)

Approvers:
  - https://github.com/jakirkham

URL: #138
  • Loading branch information
quasiben authored Nov 3, 2021
1 parent fa6c5b5 commit 10582fc
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 8 deletions.
22 changes: 22 additions & 0 deletions docs/references.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* Fix references to not look like parameters */
dl.citation > dt.label {
display: unset !important;
float: left !important;
border: unset !important;
background: unset !important;
padding: unset !important;
margin: unset !important;
font-size: unset !important;
line-height: unset !important;
padding-right: 0.5rem !important;
}

/* Add opening bracket */
dl.citation > dt.label > span::before {
content: "[";
}

/* Add closing bracket */
dl.citation > dt.label > span::after {
content: "]";
}
4 changes: 2 additions & 2 deletions docs/requirement.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx
sphinx_rtd_theme
pydata-sphinx-theme
numpydoc
ipython
ipython
21 changes: 21 additions & 0 deletions docs/source/_static/params.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,24 @@
margin: 0.5em;
content: ":";
}

:root {

--pst-color-active-navigation: 114, 83, 237;
--pst-color-navbar-link: 77, 77, 77;
--pst-color-navbar-link-hover: var(--pst-color-active-navigation);
--pst-color-navbar-link-active: var(--pst-color-active-navigation);
--pst-color-sidebar-link: 77, 77, 77;
--pst-color-sidebar-link-hover: var(--pst-color-active-navigation);
--pst-color-sidebar-link-active: var(--pst-color-active-navigation);
--pst-color-sidebar-expander-background-hover: 244, 244, 244;
--pst-color-sidebar-caption: 77, 77, 77;
--pst-color-toc-link: 119, 117, 122;
--pst-color-toc-link-hover: var(--pst-color-active-navigation);
--pst-color-toc-link-active: var(--pst-color-active-navigation);

}

.special-table td, .special-table th {
border: 1px solid #dee2e6;
}
9 changes: 4 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
# a list of builtin themes.
#

html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_rtd_theme'

# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
Expand All @@ -109,10 +109,9 @@
# only import and set the theme if we're building docs locally
# otherwise, readthedocs.org uses their theme by default,
# so no need to specify it
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

import pydata_sphinx_theme
html_theme = 'pydata_sphinx_theme'
html_theme_path = pydata_sphinx_theme.get_html_theme_path()

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

Welcome to cuCIM's documentation!
====================================

cuCIM is a an extensible toolkit designed to provide GPU-accelearted I/O,
computer vision and image processing primitives for N-Dimensional images
with a focus on biomedical imaging. Our API mirrors `scikit-image
Expand Down

0 comments on commit 10582fc

Please sign in to comment.