diff --git a/README.md b/README.md index 99be11b..f563df5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Argument checking for python programs +

+ dargs — argument schemas for Python +

+ [![conda-forge](https://img.shields.io/conda/dn/conda-forge/dargs?color=red&label=conda-forge&logo=conda-forge)](https://anaconda.org/conda-forge/dargs) [![pip install](https://img.shields.io/pypi/dm/dargs?label=pip%20install&logo=pypi)](https://pypi.org/project/dargs) [![Documentation Status](https://readthedocs.org/projects/dargs/badge/)](https://dargs.readthedocs.io/) diff --git a/docs/_static/dargs-logo.svg b/docs/_static/dargs-logo.svg new file mode 100644 index 0000000..f111941 --- /dev/null +++ b/docs/_static/dargs-logo.svg @@ -0,0 +1,36 @@ + + dargs logo + A stylized letter D containing an indented argument schema, followed by the dargs wordmark. + + + + + + + + + + + + + + + + + + + + + + + + + dargs + + + + + + + diff --git a/docs/conf.py b/docs/conf.py index 4cac5c4..c7efa39 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -140,6 +140,11 @@ def _get_release() -> str: # # html_sidebars = {} +# Use the project mark in generated HTML documentation. The SVG lives in +# ``docs/_static`` so it is also available as a relative asset from README.md. +html_static_path = ["_static"] +html_logo = "_static/dargs-logo.svg" + # -- Options for HTMLHelp output --------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 8158bdf..20f0541 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,10 @@ Welcome to dargs's documentation! ================================== +.. image:: _static/dargs-logo.svg + :alt: dargs — argument schemas for Python + :width: 560px + .. toctree:: :maxdepth: 2 :caption: Contents: