Carlos Martín Nieto 31fc235b59 Fix sphinx complaints about the docs

Use the right namespace so Refspec and TransferProgress show up. These
classes are not instantiated by the user, so they were not promoted to
the pygit2 module. Use autoclass so it lists everything for us.

Also use autoclass for the reflog. We had a difference is oid vs id
between the docs and the code.

2014-07-10 08:25:54 +02:00

1.2 KiB

Raw Blame History

Remotes

pygit2.Repository.remotes

pygit2.Repository.create_remote

The Remote type

pygit2.Remote

The TransferProgress type

This class contains the data which is available to us during a fetch.

pygit2.remote.TransferProgress

The Refspec type

pygit2.refspec.Refspec

Credentials

pygit2.Remote.credentials

There are two types of credentials: username/password and SSH key pairs. Both :pypygit2.UserPass and :pypygit2.Keypair are callable objects, with the appropriate signature for the credentials callback. They will ignore all the arguments and return themselves. This is useful for scripts where the credentials are known ahead of time. More complete interfaces would want to look up in their keychain or ask the user for the data to use in the credentials.

pygit2.UserPass

pygit2.Keypair

1.2 KiB Raw Blame History