better documentation on optional dependencies

fixes #225.
[skip ci]
This commit is contained in:
lilydjwg 2023-06-02 00:43:49 +08:00
parent ac57d8fd15
commit d3603fcee8
1 changed files with 9 additions and 1 deletions

View File

@ -328,6 +328,7 @@ post_data_type
.. note:: .. note::
An additional dependency "lxml" is required. An additional dependency "lxml" is required.
You can use ``pip install 'nvchecker[htmlparser]'``.
Find with a Command Find with a Command
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -536,6 +537,10 @@ pypi
use_pre_release use_pre_release
Whether to accept pre release. Default is false. Whether to accept pre release. Default is false.
.. note::
An additional dependency "packaging" is required.
You can use ``pip install 'nvchecker[pypi]'``.
Check RubyGems Check RubyGems
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
:: ::
@ -874,6 +879,9 @@ strip_release
provided provided
Instead of the package version, return the version this package provides. Its value is what the package provides, and ``strip_release`` takes effect too. This is best used with libraries. Instead of the package version, return the version this package provides. Its value is what the package provides, and ``strip_release`` takes effect too. This is best used with libraries.
.. note::
An additional dependency "pyalpm" is required.
Check ALPM files database Check ALPM files database
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::