BioArchLinux/nvchecker
2
0
Fork 0
mirror of https://github.com/lilydjwg/nvchecker.git synced 2025-03-10 06:14:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: add an inline sample config

Browse source 
also fix the code block display
This commit is contained in:
lilydjwg 2021-07-01 19:38:17 +08:00
parent 0f44759b35
commit f8dd1a4212
2 changed files with 21 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/usage.rst
View file

@ -44,7 +44,19 @@ To see available options::
Run with one or more software version files:: Run with one or more software version files::
nvchecker -c config_file nvchecker -c config_file.toml
A simple config file may look like:
.. code-block:: toml
[nvchecker]
source = "github"
github = "lilydjwg/nvchecker"
[python-toml]
source = "pypi"
pypi = "toml"
You normally will like to specify some "version record files"; see below. You normally will like to specify some "version record files"; see below.
@ -110,7 +122,7 @@ Configuration Files
------------------- -------------------
The software version source files are in `toml`_ format. The *key name* is the name of the software. Following fields are used to tell nvchecker how to determine the current version of that software. The software version source files are in `toml`_ format. The *key name* is the name of the software. Following fields are used to tell nvchecker how to determine the current version of that software.
See ``sample_source.toml`` for an example. See `sample_source.toml <https://github.com/lilydjwg/nvchecker/blob/master/sample_config.toml>`_ for an example.
Configuration Table Configuration Table
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -142,12 +154,12 @@ keyfile
Sample ``keyfile.toml``: Sample ``keyfile.toml``:
```toml .. code-block:: toml
[keys]
# https://github.com/settings/tokens [keys]
# scope: repo -> public_repo # https://github.com/settings/tokens
github = "ghp_<stripped>" # scope: repo -> public_repo
``` github = "ghp_<stripped>"
Global Options Global Options
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~

2
nvchecker/api.py
View file

@ -8,4 +8,4 @@ from .util import (
) )
from .sortversion import sort_version_keys from .sortversion import sort_version_keys
from .ctxvars import tries, proxy, user_agent, httptoken, entry_waiter from .ctxvars import tries, proxy, user_agent, httptoken, entry_waiter, verify_cert