diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index 71b2eab..5630272 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -1,32 +1,73 @@ -/* Make the page wider so e.g. the status table can be seen fully */ -.wy-nav-content { - max-width: 1200px !important; +@import "../basic.css"; + +html[data-theme="light"] { + --pst-color-primary: #ed1c24; + --pst-color-warning: #ed1c24; + --pst-color-primary-highlight: #bc151b; + --pst-color-secondary: #1d35e7; + --pst-color-secondary-highlight: #3e51e3; + } -.column_left { - display: table-cell; - width: 60px; - vertical-align: middle; + +html[data-theme="dark"] { + --pst-color-primary: #ed1c24; + --pst-color-warning: #ed1c24; + --pst-color-primary-highlight: #bc151b; + --pst-color-background: #1A1A1A; + --pst-color-secondary: #1d35e7; + --pst-color-secondary-highlight: #3e51e3; + + } -.column { - display: table-cell; + +html[data-theme="light"] a:hover { + color: #1A1A1A; } -.column_right { - display: table-cell; - width: 60px; - vertical-align: middle; + +html[data-theme="dark"] h1, html[data-theme="dark"] h2, html[data-theme="dark"] h3, html[data-theme="dark"] h4, html[data-theme="dark"] h5, html[data-theme="dark"] h6 { + color: #ffffff; } -/* Clear floats after the columns */ -.row:after { - content: ""; - display: table; - clear: both; + +html[data-theme="dark"] a { + color: #ffffff; +} + +html[data-theme="dark"] .reference.external { + text-decoration: underline; + +} + +html[data-theme="dark"] p .reference.internal { + text-decoration: underline; + } -/* Numbering equations */ -.math { - text-align: left; +html[data-theme="dark"] a:hover { + color: #ed1c24; } -.eqno { - float: right; + +html[data-theme="dark"] .prev-next-area a p.prev-next-title { + color: white; +} + +html[data-theme="dark"] .prev-next-area:hover a:hover p.prev-next-title:hover { + color: #ed1c24; +} + +html[data-theme="dark"] dt:target { + background-color: #000000; +} + +html .toctree-wrapper li[class^=toctree-l] { + list-style: circle; +} + +img:not(.logo__image, .footer_logo) { + padding: 20px; +} + + +.footer_logo { + max-height: 60px; } diff --git a/docs/_static/molssi_main_logo.png b/docs/_static/molssi_main_logo.png new file mode 100644 index 0000000..1eb1d71 Binary files /dev/null and b/docs/_static/molssi_main_logo.png differ diff --git a/docs/_static/molssi_main_logo_inverted_white.png b/docs/_static/molssi_main_logo_inverted_white.png new file mode 100644 index 0000000..051bebd Binary files /dev/null and b/docs/_static/molssi_main_logo_inverted_white.png differ diff --git a/docs/_static/nsf.png b/docs/_static/nsf.png new file mode 100644 index 0000000..c18ce33 Binary files /dev/null and b/docs/_static/nsf.png differ diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html deleted file mode 100644 index 2012c19..0000000 --- a/docs/_templates/footer.html +++ /dev/null @@ -1,22 +0,0 @@ -{% extends "!footer.html" %} -{% block extrafooter %} - -

-

-
- - The MolSSI - -
-
- © Copyright 2022, the Molecular Sciences Software Institute, - which receives funding from the National Science Foundation under awards - CHE-2136142. -
-
- - The NSF - -
-
-{% endblock %} \ No newline at end of file diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 8d472bf..744f5ea 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -1,4 +1,4 @@ -{%- extends "sphinx_rtd_theme/layout.html" %} +{%- extends "pydata_sphinx_theme/layout.html" %} {%- block content %} diff --git a/docs/_templates/molssi_footer.html b/docs/_templates/molssi_footer.html new file mode 100644 index 0000000..969c9a5 --- /dev/null +++ b/docs/_templates/molssi_footer.html @@ -0,0 +1,44 @@ +{% if not theme_logo.get("link") %} + {% set href = pathto(root_doc) %} +{% elif hasdoc(theme_logo.get("link")) %} + {% set href = pathto(theme_logo.get("link")) %} {# internal page #} +{% else %} + {% set href = theme_logo.get("link") %} {# external url #} +{% endif %} + +{# get all the brand information from html_theme_option #} + {% set is_logo = logo or theme_logo.get("image_light") or theme_logo.get("image_dark") %} + {% set image_light = theme_logo.get("molssi_light") or logo %} + {% set image_dark = theme_logo.get("molssi_dark") or logo %} + {% set image_light = image_light if image_light.startswith("http") else pathto('_static/' + image_light, 1) %} + {% set image_dark = image_dark if image_dark.startswith("http") else pathto('_static/' + image_dark, 1) %} + {% set alt = theme_logo.get("alt_text", "Logo image") %} + {% set nsf_logo = pathto('_static/' + 'nsf.png', 1) %} + + +
+
+ + + + +
+
+

© Copyright 2019-2023 The Molecular Sciences Software Institute

+

Funded by the National Science Foundation + OAC-1547580 and + CHE-2136142.

+ + {% if show_sphinx %} +

+ {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %}
+

+ {% endif %} + +
+
+ + + +
+
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 112abaa..e501457 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,6 +51,8 @@ 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.extlinks', + 'sphinx_design', + 'sphinx_copybutton' ] autosummary_generate = True @@ -91,25 +93,44 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -# html_theme = 'sphinx_rtd_theme' -html_theme = 'renku' +html_theme = 'pydata_sphinx_theme' # 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 # documentation. # # html_theme_options = {} +# html_theme_options = { +# 'logo_only': True, +# 'display_version': True, +# 'prev_next_buttons_location': 'bottom', +# 'style_external_links': False, +# # Toc options +# 'collapse_navigation': True, +# 'sticky_navigation': True, +# 'navigation_depth': 4, +# 'includehidden': True, +# 'titles_only': False +# } html_theme_options = { - 'logo_only': True, - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': False, - # Toc options - 'collapse_navigation': True, - 'sticky_navigation': True, - 'navigation_depth': 4, - 'includehidden': True, - 'titles_only': False + "github_url": "https://github.com/MolSSI/zenopy", + "twitter_url": "https://twitter.com/MolSSI_NSF", + + "logo": { + "image_light": "molssi-zenopy_white_bg.png", + "image_dark": "molssi-zenopy_white_bg.png", + "text": "", + "molssi_light": "molssi_main_logo.png", + "molssi_dark": "molssi_main_logo_inverted_white.png", + }, + "show_toc_level": 2, + "header_links_before_dropdown": 4, + "external_links": [ + {"name": "MolSSI", "url": "https://molssi.org"} +], + + "secondary_sidebar_items": ["page-toc", "sourcelink"], + "footer_items": [ "molssi_footer" ], } # Path to project's logo diff --git a/docs/index.rst b/docs/index.rst index 9ef3324..12557bd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,11 +15,56 @@ of the `Zenodo `_ API to researchers and software developers This package is a part of the data engineering domain infrastructure in the Chem-AI software ecosystem. +.. grid:: 1 1 2 2 + + .. grid-item-card:: Quick Start + :margin: 0 3 0 0 + + Jump right into using zenopy! + + .. button-link:: ./quick_start.html + :color: primary + :expand: + + Quick Start Guide + + .. grid-item-card:: How-to Guides + :margin: 0 3 0 0 + + A collection of How-to Guides for busy users + + .. button-link:: ./howtos/index.html + :color: primary + :expand: + + How-to Guides + + .. grid-item-card:: API Reference + :margin: 0 3 0 0 + + Application programming interface (API) references + + .. button-link:: ./api/index.html + :color: primary + :expand: + + API Reference + + .. grid-item-card:: Developer Guide + :margin: 0 3 0 0 + + Deeper insights into zenopy infrastructure + + .. button-link:: ./tutorials/index.html + :color: primary + :expand: + + Developer Guide + .. Table of Contents .. toctree:: - :maxdepth: 2 + :hidden: :titlesonly: - :numbered: 2 installation quick_start diff --git a/requirements.txt b/requirements.txt index 164b97f..09a3e39 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,5 @@ requests validators -renku-sphinx-theme \ No newline at end of file +pydata-sphinx-theme +sphinx-design +sphinx-copybutton \ No newline at end of file diff --git a/setup.py b/setup.py index 5938027..1234211 100644 --- a/setup.py +++ b/setup.py @@ -35,8 +35,9 @@ "docs": [ "sphinx==1.2.3", "sphinxcontrib-napoleon", - "sphinx_rtd_theme", - "renku-sphinx-theme", + "pydata-sphinx-theme", + "sphinx-design", + "sphinx-copybutton", "numpydoc", ], "tests": ["pytest", "pytest-cov"],