diff --git a/docs/references.css b/docs/references.css new file mode 100644 index 000000000..3d3721070 --- /dev/null +++ b/docs/references.css @@ -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: "]"; +} diff --git a/docs/requirement.txt b/docs/requirement.txt index f636fd879..bf9d4efdc 100644 --- a/docs/requirement.txt +++ b/docs/requirement.txt @@ -1,4 +1,4 @@ sphinx -sphinx_rtd_theme +pydata-sphinx-theme numpydoc -ipython \ No newline at end of file +ipython diff --git a/docs/source/_static/params.css b/docs/source/_static/params.css index dc5cb9640..c080d3669 100644 --- a/docs/source/_static/params.css +++ b/docs/source/_static/params.css @@ -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; +} diff --git a/docs/source/conf.py b/docs/source/conf.py index ca53875ec..35800c1d4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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' @@ -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 diff --git a/docs/source/index.rst b/docs/source/index.rst index cc1b890e0..5c8dd9fcc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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