Skip to content

Fix sphinx complaints about the docs #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdavid merged 1 commit into from
Jul 10, 2014
Merged

Fix sphinx complaints about the docs #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
  • Loading branch information
@carlosmn
carlosmn committed Jul 10, 2014
commit 31fc235b5914475491b1321074b4ffede5cb5815
6 changes: 2 additions & 4 deletions docs/references.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,8 @@ Example::
>>> for entry in head.log():
... print(entry.message)

.. autoattribute:: pygit2.RefLogEntry.id_new
.. autoattribute:: pygit2.RefLogEntry.id_old
.. autoattribute:: pygit2.RefLogEntry.message
.. autoattribute:: pygit2.RefLogEntry.committer
.. autoclass:: pygit2.RefLogEntry
:members:

Notes
====================
Expand Down
38 changes: 6 additions & 32 deletions docs/remotes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,48 +10,22 @@ Remotes
The Remote type
====================

.. autoattribute:: pygit2.Remote.name
.. autoattribute:: pygit2.Remote.url
.. autoattribute:: pygit2.Remote.push_url
.. autoattribute:: pygit2.Remote.refspec_count
.. autoattribute:: pygit2.Remote.push_refspecs
.. autoattribute:: pygit2.Remote.fetch_refspecs
.. automethod:: pygit2.Remote.progress
.. automethod:: pygit2.Remote.transfer_progress
.. automethod:: pygit2.Remote.update_tips
.. automethod:: pygit2.Remote.get_refspec
.. automethod:: pygit2.Remote.fetch
.. automethod:: pygit2.Remote.push
.. automethod:: pygit2.Remote.save
.. automethod:: pygit2.Remote.add_push
.. automethod:: pygit2.Remote.add_fetch
.. autoclass:: pygit2.Remote
:members:

The TransferProgress type
===========================

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

.. autoattribute:: pygit2.TransferProgress.total_objects
.. autoattribute:: pygit2.TransferProgress.indexed_objects
.. autoattribute:: pygit2.TransferProgress.received_objects
.. autoattribute:: pygit2.TransferProgress.local_objects
.. autoattribute:: pygit2.TransferProgress.total_deltas
.. autoattribute:: pygit2.TransferProgress.indexed_deltas
.. autoattribute:: pygit2.TransferProgress.received_bytes

.. autoclass:: pygit2.remote.TransferProgress
:members:

The Refspec type
===================

.. autoattribute:: pygit2.Refspec.direction
.. autoattribute:: pygit2.Refspec.src
.. autoattribute:: pygit2.Refspec.dst
.. autoattribute:: pygit2.Refspec.force
.. autoattribute:: pygit2.Refspec.string
.. automethod:: pygit2.Refspec.src_matches
.. automethod:: pygit2.Refspec.dst_matches
.. automethod:: pygit2.Refspec.transform
.. automethod:: pygit2.Refspec.rtransform
.. autoclass:: pygit2.refspec.Refspec
:members:

Credentials
================
Expand Down