diff --git a/pyproject.toml b/pyproject.toml index 3d33c7f..82d6211 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,7 @@ build-backend = "setuptools.build_meta" [project] name = "libcasm-configuration" -version = "2.0a1" +version = "2.0a2" authors = [ { name="CASM developers", email="casm-developers@lists.engr.ucsb.edu" }, ] diff --git a/python/doc/_static/css/custom.css b/python/doc/_static/css/custom.css index 6d82092..d99e573 100644 --- a/python/doc/_static/css/custom.css +++ b/python/doc/_static/css/custom.css @@ -1,7 +1,116 @@ -:root[data-theme='light'], -:root[data-theme='dark'] { +:root[data-theme='light'] { --pst-color-primary: #0072b5; + --pst-color-secondary: #febc15; --pst-color-link: #0072b5; --pst-color-inline-code: #0072b5; --sd-color-card-border-hover: #0072b5; + + dt { + background-color: #eaeaea; + } + +} + +:root[data-theme='dark'] { + --pst-color-primary: #6DC8BF; + --pst-color-secondary: #CBDB2A; + --pst-color-link: #6DC8BF; + --pst-color-inline-code: #6DC8BF; + --sd-color-card-border-hover: #6DC8BF; + + dt { + background-color: #6A4729F7; + } + + /* note */ + .admonition.note > .admonition-title::before, div.admonition.note > .admonition-title::before { + background-color: #8739b3; + } + + .admonition.note > .admonition-title::after, div.admonition.note > .admonition-title::after { + color: #c695c5; + content: var(--pst-icon-admonition-note); + } + + .admonition.note, div.admonition.note { + border-color: #c695c5; + } + + /* deprecated */ + --pst-color-danger: #f9e1e4; + --pst-color-danger-bg: #d72d47; +} + + + +/* Fix breadcrumb overlap https://github.com/holoviz/panel/issues/5199 */ +.header-article__inner .header-article-item { + height: unset; +} + +/* Homepage Showcase */ + +.showcase-table { + border-spacing: 15px; +} + +.showcase-table td { + border: 0px; + vertical-align: top; +} + +/* Homepage sponsors */ + +.sd-card-body.sponsor-logo { + flex-grow: unset; + margin: auto; +} + +.sponsor-logo img { + min-height: 80px; + object-fit: contain; +} + +/* Tweaks for code cell rendering */ + +.highlight { + border-radius: 4px; +} + +html[data-theme='light'] .highlight { + background-color: #263238; + color: #f8f8f2; +} + +pre[id^='codecell'] { + background-color: unset; + border: none; + border-radius: 0.5em; + color: #f8f8f2; + box-shadow: none; + padding: 1.5em; +} + +div.highlight button.copybtn.o-tooltip--left:after { + background-color: #263235; + border: 1px solid gray; + border-radius: 4px; + padding: 5px; +} + +button.copybtn { + background-color: #263238; +} + +button.copybtn:hover { + background-color: #263238; + color: #f8f8f2; +} + +.highlight button.copybtn:hover { + background: none; +} + +.o-tooltip--left:after { + background: none; } diff --git a/python/doc/_static/logo_dark.svg b/python/doc/_static/logo_dark.svg new file mode 100644 index 0000000..7531e64 --- /dev/null +++ b/python/doc/_static/logo_dark.svg @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A Clusters App +r +oach to Statistical Mechanics +CASM + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/python/doc/_static/logo_dark_outline.svg b/python/doc/_static/logo_dark_outline.svg new file mode 100644 index 0000000..052b823 --- /dev/null +++ b/python/doc/_static/logo_dark_outline.svg @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/python/doc/_static/logo_outline.svg b/python/doc/_static/logo_outline.svg new file mode 100644 index 0000000..7300fdb --- /dev/null +++ b/python/doc/_static/logo_outline.svg @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/python/doc/_static/small_logo.svg b/python/doc/_static/small_logo.svg index 0f1e8ef..e571f55 100644 --- a/python/doc/_static/small_logo.svg +++ b/python/doc/_static/small_logo.svg @@ -1 +1,48 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/python/doc/_static/small_logo_dark.svg b/python/doc/_static/small_logo_dark.svg new file mode 100644 index 0000000..2298841 --- /dev/null +++ b/python/doc/_static/small_logo_dark.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/python/doc/conf.py b/python/doc/conf.py index 75ef28b..07153e4 100644 --- a/python/doc/conf.py +++ b/python/doc/conf.py @@ -25,7 +25,7 @@ autosummary_generate = True autosummary_imported_members = True numpydoc_show_class_members = False -autodoc_typehints = "description" +# autodoc_typehints = 'both' autodoc_typehints_format = "short" python_use_unqualified_type_names = True autodoc_inherit_docstrings = False @@ -60,11 +60,11 @@ "sphinx.ext.viewcode", "sphinx.ext.githubpages", "sphinx.ext.napoleon", + "sphinx_favicon", "sphinxarg.ext", "sphinxcontrib.bibtex", "sphinx.ext.intersphinx", "numpydoc", - "sphinx_copybutton", ] bibtex_bibfiles = ["refs.bib"] @@ -97,7 +97,7 @@ # The short X.Y version. version = "2.0" # The full version, including alpha/beta/rc tags. -release = "2.0a1" +release = "2.0a2" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -112,7 +112,7 @@ exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" +# pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -131,23 +131,23 @@ html_logo = "_static/small_logo.svg" html_theme_options = { "logo": { - "text": "libcasm-configuration", - } + "text": "libcasm-xtal", + "image_light": "_static/small_logo.svg", + "image_dark": "_static/small_logo_dark.svg", + }, + "pygment_light_style": "xcode", + "pygment_dark_style": "lightbulb", } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] html_favicon = "_static/small_logo.svg" +favicons = ["small_logo.svg"] html_css_files = [ "css/custom.css", ] -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - # Custom sidebar templates, must be a dictionary that maps document names # to template names. # @@ -224,7 +224,7 @@ "libcasm-configuration Documentation", author, "libcasm-configuration", - "One line description of project.", + "CASM configuration comparison and enumeration", "Miscellaneous", ), ] diff --git a/python/doc/index.rst b/python/doc/index.rst index c52a5ec..9f1f344 100644 --- a/python/doc/index.rst +++ b/python/doc/index.rst @@ -1,6 +1,12 @@ -.. image:: _static/logo.svg +.. image:: _static/logo_outline.svg :alt: CASM logo :width: 600 + :class: only-light + +.. image:: _static/logo_dark_outline.svg + :alt: CASM logo + :width: 600 + :class: only-dark libcasm-configuration ===================== diff --git a/python/setup.py b/python/setup.py index c09405d..9e66510 100644 --- a/python/setup.py +++ b/python/setup.py @@ -1,6 +1,6 @@ import os -__version__ = "2.0a1" +__version__ = "2.0a2" # Available at setup time due to pyproject.toml from pybind11.setup_helpers import Pybind11Extension, build_ext diff --git a/setup.py b/setup.py index d080e7b..e63efa9 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name="libcasm-configuration", - version="2.0a1", + version="2.0a2", packages=[ "libcasm", "libcasm.clusterography",