mirror of https://github.com/jab/bidict.git
docs + badges tweaks
- add participation section to intro - rm paypal, bountysource, and star badges from set of status badges - docs badge now links to "stable" version - add contributing to sphinx docs - add favicon to sphinx docs - fix logo and gumroad image urls
This commit is contained in:
jab
parent
48ce1ec66b
commit
c2f975b5ff
|
|
@ -1,3 +1,5 @@
|
|||
.. _contributing:
|
||||
|
||||
Contributors' Guide
|
||||
===================
|
||||
|
||||
|
|
@ -112,7 +114,7 @@ especially work you've been paid for,
|
|||
please `support bidict <https://gumroad.com/l/bidict>`_
|
||||
and/or ask your organization to do the same.
|
||||
|
||||
.. image:: ./docs/_static/support-on-gumroad.png
|
||||
.. image:: https://raw.githubusercontent.com/jab/bidict/master/docs/_static/support-on-gumroad.png
|
||||
:target: https://gumroad.com/l/bidict
|
||||
:alt: Support bidict
|
||||
|
||||
|
|
|
|||
22
README.rst
22
README.rst
|
|
@ -3,7 +3,7 @@ bidict
|
|||
|
||||
Efficient, Pythonic bidirectional map implementation and related functionality.
|
||||
|
||||
.. image:: ./docs/_static/logo.png
|
||||
.. image:: https://raw.githubusercontent.com/jab/bidict/master/docs/_static/logo.png
|
||||
:target: https://bidict.readthedocs.org/
|
||||
:alt: bidict logo
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ Status
|
|||
:target: https://pypi.python.org/pypi/bidict
|
||||
:alt: Latest release
|
||||
|
||||
.. image:: https://readthedocs.org/projects/bidict/badge/?version=master
|
||||
.. image:: https://readthedocs.org/projects/bidict/badge/?version=stable
|
||||
:target: https://bidict.readthedocs.org/
|
||||
:alt: Documentation
|
||||
|
||||
|
|
@ -47,26 +47,10 @@ Status
|
|||
:target: https://raw.githubusercontent.com/jab/bidict/master/LICENSE
|
||||
:alt: License
|
||||
|
||||
.. image:: https://img.shields.io/badge/gumroad-support%20bidict-brightgreen.svg
|
||||
:target: https://gumroad.com/l/bidict
|
||||
:alt: Support bidict
|
||||
|
||||
.. image:: https://img.shields.io/badge/Paypal-Buy%20a%20Drink-blue.svg
|
||||
:target: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=jab%40math%2ebrown%2eedu&lc=US&item_name=Buy%20a%20drink%20for%20jab&button_subtype=services¤cy_code=USD&bn=PP%2dBuyNowBF%3aPaypal%2dBuy%2520a%2520Drink%2dblue%2esvg%3aNonHosted
|
||||
:alt: PayPal - Buy a drink
|
||||
|
||||
.. image:: https://img.shields.io/bountysource/team/jab/activity.svg
|
||||
:target: https://www.bountysource.com/teams/jab
|
||||
:alt: Bountysource
|
||||
|
||||
.. image:: https://badges.gitter.im/Join%20Chat.svg
|
||||
:alt: Chat
|
||||
:target: https://gitter.im/jab/bidict
|
||||
|
||||
.. image:: https://img.shields.io/github/stars/jab/bidict.svg?style=social&label=Star
|
||||
:target: https://github.com/jab/bidict/stargazers
|
||||
:alt: Star on GitHub
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
|
|
@ -91,7 +75,7 @@ please `support bidict <https://gumroad.com/l/bidict>`_
|
|||
and/or ask your organization to do the same.
|
||||
Your support directly contributes to bidict's sustainability.
|
||||
|
||||
.. image:: ./docs/_static/support-on-gumroad.png
|
||||
.. image:: https://raw.githubusercontent.com/jab/bidict/master/docs/_static/support-on-gumroad.png
|
||||
:target: https://gumroad.com/l/bidict
|
||||
:alt: Support bidict
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 361 KiB |
|
|
@ -134,7 +134,7 @@ html_logo = '_static/logo.png'
|
|||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = 'favicon.ico'
|
||||
html_favicon = '_static/favicon.ico'
|
||||
|
||||
# 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,
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
../CONTRIBUTING.rst
|
||||
|
|
@ -6,7 +6,34 @@ and related functionality.
|
|||
|
||||
.. include:: status.rst.inc
|
||||
|
||||
:ref:`Let's get started <intro>`.
|
||||
|
||||
Participation
|
||||
-------------
|
||||
|
||||
Please feel free to `create an issue <https://github.com/jab/bidict/issues/new>`_
|
||||
or `join the chat room <https://gitter.im/jab/bidict>`_
|
||||
if you have any questions, feedback, or just want to say hi or
|
||||
talk about your use case.
|
||||
|
||||
bidict is the result of hundreds of hours of voluntary, unpaid work.
|
||||
If bidict has helped you accomplish work you've been paid for,
|
||||
please `support bidict <https://gumroad.com/l/bidict>`_
|
||||
and/or ask your organization to do the same.
|
||||
Your support directly contributes to bidict's sustainability.
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/jab/bidict/master/docs/_static/support-on-gumroad.png
|
||||
:target: https://gumroad.com/l/bidict
|
||||
:alt: Support bidict
|
||||
|
||||
:ref:`Click here <contributing>`
|
||||
for more information about contributing.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Let's get :ref:`started <intro>`.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
@ -20,3 +47,4 @@ and related functionality.
|
|||
addendum
|
||||
changelog
|
||||
api
|
||||
contributing
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
:target: https://pypi.python.org/pypi/bidict
|
||||
:alt: Latest release
|
||||
|
||||
.. image:: https://readthedocs.org/projects/bidict/badge/?version=master
|
||||
.. image:: https://readthedocs.org/projects/bidict/badge/?version=stable
|
||||
:target: https://bidict.readthedocs.org/
|
||||
:alt: Documentation
|
||||
|
||||
|
|
@ -34,22 +34,6 @@
|
|||
:target: https://raw.githubusercontent.com/jab/bidict/master/LICENSE
|
||||
:alt: License
|
||||
|
||||
.. image:: https://img.shields.io/badge/gumroad-support%20bidict-brightgreen.svg
|
||||
:target: https://gumroad.com/l/bidict
|
||||
:alt: Support bidict
|
||||
|
||||
.. image:: https://img.shields.io/badge/Paypal-Buy%20a%20Drink-blue.svg
|
||||
:target: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=jab%40math%2ebrown%2eedu&lc=US&item_name=Buy%20a%20drink%20for%20jab&button_subtype=services¤cy_code=USD&bn=PP%2dBuyNowBF%3aPaypal%2dBuy%2520a%2520Drink%2dblue%2esvg%3aNonHosted
|
||||
:alt: PayPal - Buy a drink
|
||||
|
||||
.. image:: https://img.shields.io/bountysource/team/jab/activity.svg
|
||||
:target: https://www.bountysource.com/teams/jab
|
||||
:alt: Bountysource
|
||||
|
||||
.. image:: https://badges.gitter.im/Join%20Chat.svg
|
||||
:alt: Chat
|
||||
:target: https://gitter.im/jab/bidict
|
||||
|
||||
.. image:: https://img.shields.io/github/stars/jab/bidict.svg?style=social&label=Star
|
||||
:target: https://github.com/jab/bidict/stargazers
|
||||
:alt: Star on GitHub
|
||||
|
|
|
|||
Loading…
Reference in New Issue