Skip to content

Commit

Permalink
Update docs with logos etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
lmcinnes committed Nov 9, 2022
1 parent accec0f commit 04efeb9
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 1 deletion.
52 changes: 52 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
.. -*- mode: rst -*-
.. image:: doc/glasbey_logo.png
:width: 600
:alt: Glasbey logo
:align: center

|pypi_version|_ |License|_ |build_status|_ |Coverage|_ |Docs|_

.. |pypi_version| image:: https://img.shields.io/pypi/g/glasbey.svg
.. _pypi_version: https://pypi.python.org/pypi/glasbey/

.. |License| image:: https://img.shields.io/pypi/g/glasbey.svg
.. _License: https://github.com/lmcinnes/glasbey/blob/main/LICENSE

.. |build_status| image:: https://dev.azure.com/lelandmcinnes/Glasbey%20builds/_apis/build/status/lmcinnes.glasbey?branchName=main
.. _build_status: https://dev.azure.com/lelandmcinnes/Glasbey%20builds/_build/latest?definitionId=2&branchName=main

.. |Coverage| image:: https://coveralls.io/repos/github/lmcinnes/glasbey/badge.svg
.. _Coverage: https://coveralls.io/github/lmcinnes/glasbey

.. |Docs| image:: https://readthedocs.org/projects/glasbey/badge/?version=latest
.. _Docs: https://glasbey.readthedocs.io/en/latest/?badge=latest


=======================================
Glasbey Categorical Color Palette Tools
Expand All @@ -17,6 +41,34 @@ maximize the perceptual visual distinctiveness of colours within constraints. It
existing palette, or seed a created palette with some initial colours (perhaps your company or institutions colours).
Lastly, glasbey makes it easy to generate block palettes, suitable for working with hierarchical categories.

Create categorical palettes

.. image:: doc/glasbey_basic_palette.png
:width: 600
:alt: Glasbey basic palette example
:align: center

or constrain the palette options (e.g. to muted colours)

.. image:: doc/glasbey_muted_palette.png
:width: 600
:alt: Glasbey muted palette example
:align: center

or extend existing palettes

.. image:: doc/glasbey_tab10_palette.png
:width: 600
:alt: Glasbey extending tab10 example
:align: center

or create block categorical palettes

.. image:: doc/glasbey_block_palette.png
:width: 600
:alt: Glasbey block palette example
:align: center

-----------
Basic Usage
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
#
html_theme_options = {"navigation_depth": 3, "logo_only": True}

html_logo = "pynndescent_logo_no_text.png"
html_logo = "glasbey_logo_rtd.png"

# 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,
Expand Down
Binary file added doc/glasbey_basic_palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/glasbey_block_palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/glasbey_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/glasbey_logo_rtd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/glasbey_logo_vert_small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/glasbey_muted_palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/glasbey_tab10_palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. image:: doc/glasbey_logo.png
:width: 600
:alt: Glasbey logo
:align: center

=======================================
Glasbey Categorical Color Palette Tools
Expand Down

0 comments on commit 04efeb9

Please sign in to comment.