diff options
author | Seth Michael Larson <sethmichaellarson@gmail.com> | 2020-09-09 11:57:26 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-09 11:57:26 -0500 |
commit | 70d89cbe084e4367d42773d234ad62d29759a14a (patch) | |
tree | 7ee20bc5b2258b39c172f24ad2cfc1ebefc10d5d | |
parent | 0df65fad77ae649a846ed89421927b7d6eb8d803 (diff) | |
download | urllib3-70d89cbe084e4367d42773d234ad62d29759a14a.tar.gz |
Stricter RTD builds, move Sponsors to docs (#1954)
-rw-r--r-- | .readthedocs.yml | 14 | ||||
-rw-r--r-- | README.rst | 24 | ||||
-rw-r--r-- | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/requirements.txt | 2 | ||||
-rw-r--r-- | docs/sponsors.rst | 27 | ||||
-rw-r--r-- | docs/user-guide.rst | 2 |
6 files changed, 44 insertions, 27 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..1da640f0 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,14 @@ +version: 2 + +python: + install: + - method: pip + path: . + extra_requirements: + - brotli + - secure + - socks + - requirements: docs/requirements.txt + +sphinx: + fail_on_warning: true @@ -27,7 +27,9 @@ standard libraries: - Proxy support for HTTP and SOCKS. - 100% test coverage. -urllib3 is powerful and easy to use:: +urllib3 is powerful and easy to use: + +.. code-block:: python >>> import urllib3 >>> http = urllib3.PoolManager() @@ -43,7 +45,7 @@ Installing urllib3 can be installed with `pip <https://pip.pypa.io>`_:: - $ pip install urllib3 + $ python -m pip install urllib3 Alternatively, you can grab the latest source code from `GitHub <https://github.com/urllib3/urllib3>`_:: @@ -72,6 +74,7 @@ To report a security vulnerability, please use the `Tidelift security contact <https://tidelift.com/security>`_. Tidelift will coordinate the fix and disclosure with maintainers. + Maintainers ----------- @@ -89,6 +92,13 @@ Maintainers Sponsorship ----------- +If your company benefits from this library, please consider `sponsoring its +development <https://urllib3.readthedocs.io/en/latest/sponsors.html>`_. + + +For Enterprise +-------------- + .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png :width: 75 :alt: Tidelift @@ -104,13 +114,3 @@ Sponsorship tools. .. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-urllib3?utm_source=pypi-urllib3&utm_medium=referral&utm_campaign=readme - -If your company benefits from this library, please consider `sponsoring its -development <https://urllib3.readthedocs.io/en/latest/contributing.html#sponsorship-project-grants>`_. - -Sponsors include: - -- Abbott (2018-2019), sponsored `@sethmlarson <https://github.com/sethmlarson>`_'s work on urllib3. -- Google Cloud Platform (2018-2019), sponsored `@theacodes <https://github.com/theacodes>`_'s work on urllib3. -- Akamai (2017-2018), sponsored `@haikuginger <https://github.com/haikuginger>`_'s work on urllib3 -- Hewlett Packard Enterprise (2016-2017), sponsored `@Lukasa’s <https://github.com/Lukasa>`_ work on urllib3. diff --git a/docs/index.rst b/docs/index.rst index 74b89bc9..b58643ee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -74,7 +74,7 @@ For Enterprise Installing ---------- -urllib3 can be installed with `Pip <https://pip.pypa.io>`_ +urllib3 can be installed with `pip <https://pip.pypa.io>`_ .. code-block:: bash diff --git a/docs/requirements.txt b/docs/requirements.txt index 67a237ee..e1d436dc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -r ../dev-requirements.txt sphinx!=3.0.0 requests>=2,<2.16 -furo +furo==2020.9.8b4 diff --git a/docs/sponsors.rst b/docs/sponsors.rst index e691b5e2..b86fc386 100644 --- a/docs/sponsors.rst +++ b/docs/sponsors.rst @@ -1,18 +1,14 @@ Sponsors ======== -Grants ------- - Please consider sponsoring urllib3 development, especially if your company benefits from this library. Your contribution will go towards adding new features to urllib3 and making sure all functionality continues to meet our high quality standards. -We also welcome sponsorship in the form of time. We greatly appreciate companies -who encourage employees to contribute on an ongoing basis during their work hours. -Please let us know and we'll be glad to add you to our sponsors list! +Sponsors and Grants +------------------- A grant for contiguous full-time development has the biggest impact for progress. Periods of 3 to 10 days allow a contributor to tackle substantial @@ -22,12 +18,19 @@ to not fix them. Contact `@sethmlarson <https://github.com/sethmlarson>`_ or `@shazow <https://github.com/shazow>`_ to arrange a grant for a core contributor. -Huge thanks to all the companies and individuals who financially contributed to -the development of urllib3. Please send a PR if you've donated and would like -to be listed. +We also welcome sponsorship in the form of time. We greatly appreciate companies +who encourage employees to contribute on an ongoing basis during their work hours. +Let us know and we'll be glad to add you to our sponsors list. + +* `Abbott <https://abbott.com>`_ (2018-2019), sponsored `@sethmlarson <https://github.com/sethmlarson>`_ + +* `Google Cloud Platform <https://cloud.google.com>`_ (2018-2019), sponsored `@theacodes <https://github.com/theacodes>`_ + +* `GOVCERT.LU <https://govcert.lu>`_ (October 23, 2018), sponsored `@sethmlarson <https://github.com/sethmlarson>`_ -* `GOVCERT.LU <https://govcert.lu/>`_ (October 23, 2018) +* `Akamai <https://akamai.com>`_ (2017-2018) sponsored `@haikuginger <https://github.com/haikuginger>`_ -* `Stripe <https://stripe.com/>`_ (June 23, 2014) +* `Hewlett Packard Enterprise <https://hpe.com>`_ (2016-2017) sponsored + `@Lukasa’s <https://github.com/Lukasa>`_ -.. * [Company] ([date]) +* `Stripe <https://stripe.com>`_ (June 23, 2014) diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 6e7a82ce..0cb3e2c7 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -6,7 +6,7 @@ User Guide Installing ---------- -urllib3 can be installed with `Pip <https://pip.pypa.io>`_ +urllib3 can be installed with `pip <https://pip.pypa.io>`_ .. code-block:: bash |