diff --git a/CHANGELOG.md b/CHANGELOG.md index bceac6b..049cda8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ diskcache-community forked from DiskCache at upstream commit ebfa37c (3 March 20 ### Docs +- A logo: the README opens with a centered header (logo, name, tagline, links, badges) in the style of the other community forks, and the documentation shows the logo and a favicon (PR #20). - The README is rewritten in Markdown around install, usage and the fork story; the comparison tables move to a new `comparisons` page in the documentation, which gets its own landing page, and the 2016 testimonials are dropped (PR #19). - The documentation is published on Read the Docs at https://diskcache-community.readthedocs.io/, built from `master` on every push; the README links point there instead of at the `.rst` sources (PR #18). diff --git a/README.md b/README.md index 3e9452d..61542d6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ -# DiskCache - -**Disk and file backed persistent cache for Python, built on SQLite. Pure Python, thread-safe, process-safe, with a Django backend.** - -[![PyPI](https://img.shields.io/pypi/v/diskcache-community.svg)](https://pypi.org/project/diskcache-community/) -[![Python versions](https://img.shields.io/pypi/pyversions/diskcache-community.svg)](https://pypi.org/project/diskcache-community/) -[![CI](https://github.com/secondwindoss/diskcache-community/actions/workflows/ci.yml/badge.svg)](https://github.com/secondwindoss/diskcache-community/actions/workflows/ci.yml) -[![Documentation](https://app.readthedocs.org/projects/diskcache-community/badge/?version=latest)](https://diskcache-community.readthedocs.io/en/latest/) -[![License](https://img.shields.io/pypi/l/diskcache-community.svg)](https://github.com/secondwindoss/diskcache-community/blob/master/LICENSE) +
+

+ + + diskcache + +

+ +

diskcache-community

+ +

Disk and file backed persistent cache for Python, built on SQLite

+ +

+[Tutorial] +- [API] +- [Docs] +- [Changelog] +

+ +

+ Python versions + PyPI version + CI + Documentation + License +

+
> [!IMPORTANT] > This is a community fork of [python-diskcache](https://github.com/grantjenks/python-diskcache), diff --git a/docs/_static/favicon.png b/docs/_static/favicon.png new file mode 100644 index 0000000..cb735c9 Binary files /dev/null and b/docs/_static/favicon.png differ diff --git a/docs/_static/icon-dark.svg b/docs/_static/icon-dark.svg new file mode 100644 index 0000000..c7a081f --- /dev/null +++ b/docs/_static/icon-dark.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/_static/icon-light.svg b/docs/_static/icon-light.svg new file mode 100644 index 0000000..fbb1a52 --- /dev/null +++ b/docs/_static/icon-light.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/_static/icon.png b/docs/_static/icon.png new file mode 100644 index 0000000..16aff4d Binary files /dev/null and b/docs/_static/icon.png differ diff --git a/docs/_static/logo-dark.png b/docs/_static/logo-dark.png new file mode 100644 index 0000000..2338fe8 Binary files /dev/null and b/docs/_static/logo-dark.png differ diff --git a/docs/_static/logo-dark.svg b/docs/_static/logo-dark.svg new file mode 100644 index 0000000..3ea7e6c --- /dev/null +++ b/docs/_static/logo-dark.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/_static/logo-light.png b/docs/_static/logo-light.png new file mode 100644 index 0000000..ed5d4e0 Binary files /dev/null and b/docs/_static/logo-light.png differ diff --git a/docs/_static/logo-light.svg b/docs/_static/logo-light.svg new file mode 100644 index 0000000..4858e02 --- /dev/null +++ b/docs/_static/logo-light.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/api.rst b/docs/api.rst index ad81aa2..a1fb6ed 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,4 +1,9 @@ -.. automodule:: diskcache +DiskCache API Reference +======================= + +.. py:module:: diskcache + +The :doc:`tutorial` provides a helpful walkthrough of most methods. .. contents:: :local: diff --git a/docs/conf.py b/docs/conf.py index 187adc4..b5b9525 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,7 +56,8 @@ # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - 'logo_name': True, + 'logo': 'logo-light.svg', + 'logo_name': False, 'logo_text_align': 'center', 'show_powered_by': False, 'show_related': True, @@ -69,6 +70,7 @@ # 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/favicon.png' # Custom sidebar templates, maps document names to template names. html_sidebars = { diff --git a/docs/index.rst b/docs/index.rst index b3a60ff..763a474 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,6 +25,7 @@ Start with the :doc:`tutorial` and keep the :doc:`api` at hand. .. toctree:: :maxdepth: 1 + :titlesonly: tutorial cache-benchmarks