4c4968a2fb
The keyword for linking to a mehtod is 'meth', not 'method'. Setting the 'currentmodule' allows us to link without the 'pygit2' prefix in the link text.
35 lines
1.1 KiB
ReStructuredText
35 lines
1.1 KiB
ReStructuredText
**********************************************************************
|
|
Configuration files
|
|
**********************************************************************
|
|
|
|
.. autoattribute:: pygit2.Repository.config
|
|
|
|
|
|
The Config type
|
|
================
|
|
|
|
.. automethod:: pygit2.Config.get_system_config
|
|
.. automethod:: pygit2.Config.get_global_config
|
|
.. automethod:: pygit2.Config.add_file
|
|
.. automethod:: pygit2.Config.get_multivar
|
|
.. automethod:: pygit2.Config.set_multivar
|
|
|
|
.. method:: Config.__iter__()
|
|
|
|
The :class:`Config` class has an iterator which can be used to loop
|
|
through all the entries in the configuration. Each element is a tuple
|
|
containing the name and the value of each configuration variable. Be
|
|
aware that this may return multiple versions of each entry if they are
|
|
set multiple times in the configuration files.
|
|
|
|
.. currentmodule:: pygit2
|
|
|
|
The :class:`Config` Mapping interface.
|
|
|
|
When using the mapping interface, the value is returned as a
|
|
string. In order to apply the git-config parsing rules, you can use
|
|
:meth:`Config.get_bool` or :meth:`Config.get_int`.
|
|
|
|
.. automethod:: pygit2.Config.get_bool
|
|
.. automethod:: pygit2.Config.get_int
|