Skip to content

docs: add dargs logo to README and documentation #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
njzjz merged 1 commit into from
Aug 30, 2026
Merged

docs: add dargs logo to README and documentation #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Argument checking for python programs

<p align="center">
<img src="docs/_static/dargs-logo.svg" alt="dargs — argument schemas for Python" width="560">
</p>

[![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/)
Expand Down
36 changes: 36 additions & 0 deletions docs/_static/dargs-logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down