#===================================================================================================
# Entity
#===================================================================================================
-[docs]class Entity(object):
+[docs]class Entity(object):
'''
Base class for all |travisci| entities.
@@ -90,7 +90,7 @@ Source code for travispy.entities._entity
@classmethod
-[docs] def one(cls):
+[docs] def one(cls):
'''
:rtype: str
:returns:
@@ -101,7 +101,7 @@ Source code for travispy.entities._entity
@classmethod
-[docs] def many(cls):
+[docs] def many(cls):
'''
:rtype: str
:returns:
diff --git a/docs/_build/html/_modules/travispy/entities/_restartable.html b/docs/_build/html/_modules/travispy/entities/_restartable.html
index 64b2213..ad4bc6b 100644
--- a/docs/_build/html/_modules/travispy/entities/_restartable.html
+++ b/docs/_build/html/_modules/travispy/entities/_restartable.html
@@ -72,12 +72,12 @@ Source code for travispy.entities._restartable
#===================================================================================================
# Restartable
#===================================================================================================
-
[docs]class Restartable(Entity):
+[docs]class Restartable(Entity):
'''
Base class for restartable entities such as :class:`.Build` and :class:`.Job`.
'''
-[docs] def cancel(self):
+[docs] def cancel(self):
'''
Method responsible for canceling current action of this object.
@@ -89,7 +89,7 @@ Source code for travispy.entities._restartable
return response.status_code == 204
-[docs] def restart(self):
+[docs] def restart(self):
'''
Method responsible for restarting the last action executed by this action.
diff --git a/docs/_build/html/_modules/travispy/travispy.html b/docs/_build/html/_modules/travispy/travispy.html
index cbbddf0..489af29 100644
--- a/docs/_build/html/_modules/travispy/travispy.html
+++ b/docs/_build/html/_modules/travispy/travispy.html
@@ -90,7 +90,7 @@ Source code for travispy.travispy
#===================================================================================================
# TravisPy
#===================================================================================================
-[docs]class TravisPy:
+[docs]class TravisPy:
'''
Instances of this class are responsible for comunicating with |travisci|, sending requests and
handling responses properly. You can create as much instances as you want since each one will
@@ -126,7 +126,7 @@ Source code for travispy.travispy
@classmethod
-[docs] def github_auth(cls, token, uri=PUBLIC):
+[docs] def github_auth(cls, token, uri=PUBLIC):
'''
:param str token:
GitHub access token.
@@ -143,7 +143,7 @@ Source code for travispy.travispy
# Accounts -------------------------------------------------------------------------------------
-[docs] def accounts(self, all=False):
+[docs] def accounts(self, all=False):
'''
:param bool all:
Whether or not to include accounts the user does not have admin access to.
@@ -159,7 +159,7 @@ Source code for travispy.travispy
return self._session.find_many(Account, all=all)
-[docs] def account(self, account_id):
+[docs] def account(self, account_id):
'''
:param int account_id:
ID of the account to obtain information.
@@ -175,7 +175,7 @@ Source code for travispy.travispy
# Broadcasts -----------------------------------------------------------------------------------
-[docs] def broadcasts(self):
+[docs] def broadcasts(self):
'''
:rtype: list(:class:`.Broadcast`)
@@ -186,7 +186,7 @@ Source code for travispy.travispy
# Builds ---------------------------------------------------------------------------------------
-[docs] def builds(self, **kwargs):
+[docs] def builds(self, **kwargs):
'''
:keyword list(int) ids:
List of build ids to fetch.
@@ -222,7 +222,7 @@ Source code for travispy.travispy
return self._session.find_many(Build, **kwargs)
-[docs] def build(self, build_id):
+[docs] def build(self, build_id):
'''
:param int build_id:
ID of the build to obtain information.
@@ -233,7 +233,7 @@ Source code for travispy.travispy
# Hooks ----------------------------------------------------------------------------------------
-[docs] def hooks(self):
+[docs] def hooks(self):
'''
:rtype: list(:class:`.Hook`)
:returns:
@@ -246,7 +246,7 @@ Source code for travispy.travispy
# Jobs -----------------------------------------------------------------------------------------
-[docs] def jobs(self, **kwargs):
+[docs] def jobs(self, **kwargs):
'''
:keyword list(int) ids:
List of jobs IDs.
@@ -277,7 +277,7 @@ Source code for travispy.travispy
return self._session.find_many(Job, **kwargs)
-[docs] def job(self, job_id):
+[docs] def job(self, job_id):
'''
:param int job_id:
ID of the job to obtain information.
@@ -288,7 +288,7 @@ Source code for travispy.travispy
# Log ------------------------------------------------------------------------------------------
-[docs] def log(self, log_id):
+[docs] def log(self, log_id):
'''
:param int log_id:
ID of the log to obtain information.
@@ -299,7 +299,7 @@ Source code for travispy.travispy
# Repositories ---------------------------------------------------------------------------------
-[docs] def repos(self, **kwargs):
+[docs] def repos(self, **kwargs):
'''
:keyword list(int) ids:
List of repository ids to fetch, cannot be combined with other parameters.
@@ -327,7 +327,7 @@ Source code for travispy.travispy
return self._session.find_many(Repo, **kwargs)
-[docs] def repo(self, id_or_slug):
+[docs] def repo(self, id_or_slug):
'''
:type id_or_slug: int | str
:param id_or_slug:
@@ -339,7 +339,7 @@ Source code for travispy.travispy
# Users ----------------------------------------------------------------------------------------
-[docs] def user(self):
+[docs] def user(self):
'''
:rtype: :class:`.User`
:returns:
diff --git a/docs/_build/html/_sources/api.txt b/docs/_build/html/_sources/api.txt
new file mode 100644
index 0000000..23cd9b8
--- /dev/null
+++ b/docs/_build/html/_sources/api.txt
@@ -0,0 +1,19 @@
+.. |travispy| replace:: **TravisPy**
+.. |travisci| replace:: *Travis CI*
+.. |github| replace:: *GitHub*
+
+.. _official API: http://docs.travis-ci.com/api/
+.. _Ruby: https://github.com/travis-ci/travis.rb#ruby-library
+.. _requirement: http://docs.travis-ci.com/api/#external-apis
+.. _access token: https://github.com/settings/applications
+.. _entities: http://docs.travis-ci.com/api/#entities
+.. _open issues: https://github.com/menegazzo/travispy/issues?state=open
+
+===
+API
+===
+
+This document brings the public API of |travispy|.
+
+.. automodule:: travispy.travispy
+ :no-show-inheritance:
diff --git a/docs/_build/html/_sources/entities.txt b/docs/_build/html/_sources/entities.txt
new file mode 100644
index 0000000..5e9d17e
--- /dev/null
+++ b/docs/_build/html/_sources/entities.txt
@@ -0,0 +1,43 @@
+.. |travispy| replace:: **TravisPy**
+.. |travisci| replace:: *Travis CI*
+.. |github| replace:: *GitHub*
+
+.. _official API: http://docs.travis-ci.com/api/
+.. _Ruby: https://github.com/travis-ci/travis.rb#ruby-library
+.. _requirement: http://docs.travis-ci.com/api/#external-apis
+.. _access token: https://github.com/settings/applications
+.. _entities: http://docs.travis-ci.com/api/#entities
+.. _open issues: https://github.com/menegazzo/travispy/issues?state=open
+
+========
+Entities
+========
+
+This document brings information about all entities that are used by |travispy| API.
+
+.. autoclass:: Session
+ :no-show-inheritance:
+
+.. module:: travispy.entities._entity
+.. autoclass:: Entity
+ :no-show-inheritance:
+
+.. module:: travispy.entities._restartable
+.. autoclass:: Restartable
+
+.. module:: travispy.entities
+.. autoclass:: Account
+
+.. autoclass:: Broadcast
+
+.. autoclass:: Build
+
+.. autoclass:: Hook
+
+.. autoclass:: Job
+
+.. autoclass:: Log
+
+.. autoclass:: Repo
+
+.. autoclass:: User
diff --git a/docs/_build/html/_sources/getting_started.txt b/docs/_build/html/_sources/getting_started.txt
new file mode 100644
index 0000000..7d1d376
--- /dev/null
+++ b/docs/_build/html/_sources/getting_started.txt
@@ -0,0 +1,68 @@
+.. |travispy| replace:: **TravisPy**
+.. |travisci| replace:: *Travis CI*
+.. |github| replace:: *GitHub*
+
+.. _official API: http://docs.travis-ci.com/api/
+.. _Ruby: https://github.com/travis-ci/travis.rb#ruby-library
+.. _requirement: http://docs.travis-ci.com/api/#external-apis
+.. _access token: https://github.com/settings/applications
+.. _entities: http://docs.travis-ci.com/api/#entities
+.. _open issues: https://github.com/menegazzo/travispy/issues?state=open
+
+===============
+Getting started
+===============
+
+|travispy| works just as |travisci|: it authenticates against |github|. So as a `requirement`_ you
+must have a |github| `access token`_ with the following scopes:
+
+* read:org
+* user:email
+* repo_deployment
+* repo:status
+* write:repo_hook
+
+With your token in hands all is easy::
+
+ >>> from travispy import TravisPy
+ >>> t = TravisPy.github_auth()
+ >>> user = t.user()
+ >>> user
+
+
+Now you can access information related to user current logged in::
+
+ >>> user.login
+ 'travispy'
+ >>> user['login']
+ 'travispy'
+
+To get the list of repositories that you are member of::
+
+ >>> repos = t.repos(member=user.login)
+ >>> len(repos) # Ordered by recent activity
+ 5
+ >>> repos[0]
+
+ >>> repos[0].slug
+ 'travispy/on_py34'
+
+Or simply request for repository you want::
+
+ >>> repo = r.repo('travispy/on_py34')
+
+
+And finally, getting build information::
+
+ >>> build = t.build(repo.last_build_id)
+ >>> build
+
+ >>> build.restart()
+ True
+ >>> build.cancel()
+ True
+ >>> build.cancel() # As build was already cancelled it will return False.
+ False
+
+Please refer to the `official API`_ to learn more about which `entities`_ are supported. Soon a
+specific and detailed documentation related to this library will be available.
diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt
index c3f6164..1b54222 100644
--- a/docs/_build/html/_sources/index.txt
+++ b/docs/_build/html/_sources/index.txt
@@ -1,8 +1,3 @@
-.. TravisPy documentation master file, created by
- sphinx-quickstart on Wed Jul 2 10:35:41 2014.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
.. |travispy| replace:: **TravisPy**
.. |travisci| replace:: *Travis CI*
.. |github| replace:: *GitHub*
@@ -14,8 +9,9 @@
.. _entities: http://docs.travis-ci.com/api/#entities
.. _open issues: https://github.com/menegazzo/travispy/issues?state=open
-Introduction
-============
+========
+TravisPy
+========
.. automodule:: travispy
@@ -26,102 +22,15 @@ To install |travispy| all it takes is one command line::
pip install travispy
-Quick start
-===========
-
-|travispy| works just as |travisci|: it authenticates against |github|. So as a `requirement`_ you
-must have a |github| `access token`_ with the following scopes:
-
-* read:org
-* user:email
-* repo_deployment
-* repo:status
-* write:repo_hook
-
-With your token in hands all is easy::
-
- >>> from travispy import TravisPy
- >>> t = TravisPy.github_auth()
- >>> user = t.user()
- >>> user
-
-
-Now you can access information related to user current logged in::
-
- >>> user.login
- 'travispy'
- >>> user['login']
- 'travispy'
-
-To get the list of repositories that you are member of::
-
- >>> repos = t.repos(member=user.login)
- >>> len(repos) # Ordered by recent activity
- 5
- >>> repos[0]
-
- >>> repos[0].slug
- 'travispy/on_py34'
-
-Or simply request for repository you want::
-
- >>> repo = r.repo('travispy/on_py34')
-
-
-And finally, getting build information::
-
- >>> build = t.build(repo.last_build_id)
- >>> build
-
- >>> build.restart()
- True
- >>> build.cancel()
- True
- >>> build.cancel() # As build was already cancelled it will return False.
- False
-
-Please refer to the `official API`_ to learn more about which `entities`_ are supported. Soon a
-specific and detailed documentation related to this library will be available.
-
-Constants
-=========
-
-.. automodule:: travispy.travispy
- :no-members:
-
-Classes
-=======
-
-.. module:: travispy.travispy
-.. autoclass:: TravisPy
- :no-show-inheritance:
-
-.. autoclass:: Session
- :no-show-inheritance:
-
-.. module:: travispy.entities._entity
-.. autoclass:: Entity
- :no-show-inheritance:
-
-.. module:: travispy.entities._restartable
-.. autoclass:: Restartable
-
-.. module:: travispy.entities
-.. autoclass:: Account
-
-.. autoclass:: Broadcast
-
-.. autoclass:: Build
-
-.. autoclass:: Hook
-
-.. autoclass:: Job
-
-.. autoclass:: Log
-
-.. autoclass:: Repo
+Documentation
+=============
-.. autoclass:: User
+.. toctree::
+ :maxdepth: 2
+
+ getting_started
+ api
+ entities
Support
=======
diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
new file mode 100644
index 0000000..90cbcdb
--- /dev/null
+++ b/docs/_build/html/api.html
@@ -0,0 +1,418 @@
+
+
+
+
+
+
+
+ API — TravisPy 0.1.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+API¶
+This document brings the public API of TravisPy.
+
+-
+travispy.travispy.PUBLIC = URI for Travis CI free service.¶
+
+
+
+-
+travispy.travispy.PRIVATE = URI for Travis CI paid service for GitHub private repositories.¶
+
+
+
+-
+travispy.travispy.ENTERPRISE = URI template for Travis CI service running under a personal domain. Usage will be
+something like ENTERPRISE % {'domain': 'http://travis.example.com'}.¶
+
+
+
+-
+class travispy.travispy.TravisPy(token=None, uri='http://api.travis-ci.org')[source]¶
+Instances of this class are responsible for comunicating with Travis CI, sending requests and
+handling responses properly. You can create as much instances as you want since each one will
+create a separated session.
+
+Parameters:
+- token (str | None) –
Travis CI token linked to your GitHub account.
+Even if you have a public repository, some information are related to your user account
+and not the repository itself so if token is not provided an error will be returned.
+Required for private and enterprise repositories to access any information.
+
+- uri (PUBLIC | PRIVATE | ENTERPRISE | str) – URI where Travis CI service is running.
+
+
+
+Note
+Do not confuse token with the one found on your profile page.
+
+
+-
+account(account_id)[source]¶
+
+Parameters: account_id (int) – ID of the account to obtain information.
+Return type: Account
+
+
+Note
+This request always needs to be authenticated.
+
+
+
+
+-
+accounts(all=False)[source]¶
+
+Parameters: all (bool) – Whether or not to include accounts the user does not have admin access to.
+Return type: list(Account)
+Returns: Information of all accounts that the user might have access.This is usually the account
+corresponding to the user directly and one account per GitHub organization.
+
+
+Note
+This request always needs to be authenticated.
+
+
+
+
+-
+broadcasts()[source]¶
+
+Return type: list(Broadcast)
+
+
+Note
+This request always needs to be authenticated.
+
+
+
+
+-
+build(build_id)[source]¶
+
+Parameters: build_id (int) – ID of the build to obtain information.
+Return type: Build
+
+
+
+
+-
+builds(**kwargs)[source]¶
+
+Parameters:
+- ids (list(int)) – List of build ids to fetch.
+- repository_id (int) – Repository id the build belongs to.
+- slug (str) – Repository slug the build belongs to.
+- number (str) – Filter by build number, requires slug or repository_id.
+- after_number (str) – List build after a given build number (use for pagination), requires slug or
+repository_id.
+- event_type (str) – Limit build to given event type (push or pull_request).
+
+Return type: list(Build)
+
+
+Note
+You have to supply either ids, repository_id or slug.
+
+
+
+
+-
+classmethod github_auth(token, uri='http://api.travis-ci.org')[source]¶
+
+Parameters:
+- token (str) – GitHub access token.
+- uri – See __init__()
+
+
+
+
+
+-
+hooks()[source]¶
+
+Return type: list(Hook)
+Returns: Returns list of existing hooks that user have access.
+
+
+Note
+This request always needs to be authenticated.
+
+
+
+
+-
+job(job_id)[source]¶
+
+Parameters: job_id (int) – ID of the job to obtain information.
+Return type: Job
+
+
+
+
+-
+jobs(**kwargs)[source]¶
+
+Parameters:
+- ids (list(int)) – List of jobs IDs.
+- state (str) – Job state to filter by. Possible values are passed, canceled, failed and
+errored.
+- queue (str) – Job queue to filter by.
+
+Return type: list(Job)
+
+
+Note
+You need to provide exactly one of the above parameters. If you provide state or
+queue, a maximum of 250 jobs will be returned.
+
+
+
+
+-
+log(log_id)[source]¶
+
+Parameters: log_id (int) – ID of the log to obtain information.
+Return type: Log
+
+
+
+
+-
+repo(id_or_slug)[source]¶
+
+Parameters: id_or_slug (int | str) – ID of slug of repository to obtain information.
+Return type: Repo
+
+
+
+
+-
+repos(**kwargs)[source]¶
+
+Parameters:
+- ids (list(int)) – List of repository ids to fetch, cannot be combined with other parameters.
+- member (str) – Filter by user that has access to it (GitHub login).
+- owner_name (str) – Filter by owner name (first segment of slug).
+- slug (str) – Filter by slug.
+- search (str) – Filter by search term.
+- active (bool) – If True, will only return repositories that are enabled. Default is False.
+
+Return type: list(Repo)
+
+
+Note
+If no parameters are given, a list of repositories with recent activity is returned.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_build/html/entities.html b/docs/_build/html/entities.html
new file mode 100644
index 0000000..befec7b
--- /dev/null
+++ b/docs/_build/html/entities.html
@@ -0,0 +1,384 @@
+
+
+
+
+
+
+
+ Entities — TravisPy 0.1.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Entities¶
+This document brings information about all entities that are used by TravisPy API.
+
+-
+class travispy.entities._entity.Entity(session)[source]¶
+Base class for all Travis CI entities.
+
+Parameters: session (Session) – Internet session in which entity information will be requested.
+Variables: id (int) – The entity ID.
+
+
+
+
+
+
+
+
+-
+class travispy.entities._restartable.Restartable(session)[source]¶
+Bases: travispy.entities._entity.Entity
+
+
+
+
+
+
+
+
+-
+class travispy.entities.Account(session)¶
+Bases: travispy.entities._entity.Entity
+A user might have access to multiple accounts. This is usually the account corresponding to the
+user directly and one account per GitHub organization.
+
+Variables:
+- name (str) – User or organization id.
+- login (str) – Account name on GitHub.
+- type (str) – Account login on GitHub.
+- repos_count (int) – Number of repositories.
+- subscribed (bool) – Whether or not the account has a valid subscription.
+Only available on Travis Pro.
+
+
+
+
+
+-
+class travispy.entities.Broadcast(session)¶
+Bases: travispy.entities._entity.Entity
+
+Variables: message (str) – Broadcast message.
+
+
+
+
+-
+class travispy.entities.Build(session)¶
+Bases: travispy.entities._restartable.Restartable
+
+Variables:
+- repository_id (int) – Repository ID.
+- commit_id (str) – Commit ID.
+- number (str) – Build number.
+- pull_request (bool) – Whether or not the build comes from a pull request.
+- pull_request_title (str) – PR title if pull_request is True.
+- pull_request_number (str) – PR number if pull_request is True.
+- config (dict) – Build config (secure values and ssh key removed). It comes from .travis.yml file.
+- state (str) – Build state.
+- started_at (str) – Time the build was started.
+- finished_at (str) – Time the build finished.
+- duration (str) – Build duration. It might not correspond to finished_at - started_at if the
+build was restarted at a later point.
+- job_ids (list(int)) – List of job IDs in the build matrix.
+
+
+
+
+
+-
+class travispy.entities.Hook(session)¶
+Bases: travispy.entities._entity.Entity
+
+Variables:
+- name (str) – Hook name.
+- description (str) – Hook description.
+- owner_name (str) – Owner name.
+- active (str) – Whether or not the hook is active.
+- private (str) – Whether or not the hook is private.
+- admin (bool) – Whether or not current user has administrator privileges.
+
+
+
+
+
+-
+class travispy.entities.Job(session)¶
+Bases: travispy.entities._restartable.Restartable
+
+Variables:
+- build_id (int) – Build ID.
+- repository_id (int) – Repository ID.
+- commit_id (int) – Commit ID.
+- log_id (int) – Log ID.
+- number (str) – Job number.
+- config (dict) – Job config (secure values and ssh key removed). It comes from .travis.yml file.
+- state (str) – Job state.
+- started_at (str) – Time the job was started.
+- finished_at (str) – Time the job finished.
+- duration (str) – Job duration. It might not correspond to finished_at - started_at if the
+job was restarted at a later point.
+- queue (str) – Job queue.
+- allow_failure (bool) – Whether or not the job state influences build state.
+- annotation_ids (list(int)) – List of annotation IDs.
+
+
+
+
+
+-
+class travispy.entities.Log(session)¶
+Bases: travispy.entities._entity.Entity
+
+Variables:
+- job_id (int) – Jod ID.
+- body (str) – Log body.
+- type (str) –
+
+
+
+
+
+-
+class travispy.entities.Repo(session)¶
+Bases: travispy.entities._entity.Entity
+
+Variables:
+- slug (str) – Repository slug.
+- description (str) – Description on GitHub.
+- last_build_id (int) – Build ID of the last executed build.
+- last_build_number (str) – Build number of the last executed build.
+- last_build_state (str) – Build state of the last executed build.
+- last_build_duration (str) – Build duration of the last executed build.
+- last_build_started_at (str) – Build started at of the last executed build.
+- last_build_finished_at (str) – Build finished at of the last executed build.
+- github_language (str) – Language on GitHub.
+- active (bool) – Whether or not the repository is active on Travis CI.
+
+
+
+
+
+-
+class travispy.entities.User(session)¶
+Bases: travispy.entities._entity.Entity
+
+Variables:
+- login (str) – User login on GitHub.
+- name (str) – User name on GitHub.
+- email (str) – Primary email address on GitHub.
+- gravatar_id (str) – Avatar ID.
+- is_syncing (bool) – Whether or not user account is currently being synced.
+- synced_at (str) – Last synced at.
+- correct_scopes (bool) – Whether or not GitHub token has the correct scopes.
+- channels (str) – Pusher channels for this user.
+- created_at (str) – When account was created.
+- locale (str) – User main locale.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
index 7b796aa..715f2e8 100644
--- a/docs/_build/html/genindex.html
+++ b/docs/_build/html/genindex.html
@@ -73,7 +73,6 @@ Index
| B
| C
| E
- | F
| G
| H
| J
@@ -82,7 +81,6 @@ Index
| O
| P
| R
- | S
| T
| U
@@ -91,17 +89,17 @@ A
B
C
E
-
-F
-
- G
H
J
L
M
O
P
R
-
-S
-
- T
- - TravisPy (class in travispy.travispy)
+
- TravisPy (class in travispy.travispy)
@@ -325,21 +297,21 @@ T
- - travispy.entities (module)
+
- travispy.entities (module)
U
)
+ >>> user = t.user()
+ >>> user
+
+
+Now you can access information related to user current logged in::
+
+ >>> user.login
+ 'travispy'
+ >>> user['login']
+ 'travispy'
+
+To get the list of repositories that you are member of::
+
+ >>> repos = t.repos(member=user.login)
+ >>> len(repos) # Ordered by recent activity
+ 5
+ >>> repos[0]
+
+ >>> repos[0].slug
+ 'travispy/on_py34'
+
+Or simply request for repository you want::
+
+ >>> repo = r.repo('travispy/on_py34')
+
+
+And finally, getting build information::
+
+ >>> build = t.build(repo.last_build_id)
+ >>> build
+
+ >>> build.restart()
+ True
+ >>> build.cancel()
+ True
+ >>> build.cancel() # As build was already cancelled it will return False.
+ False
+
+Please refer to the `official API`_ to learn more about which `entities`_ are supported. Soon a
+specific and detailed documentation related to this library will be available.
diff --git a/docs/index.rst b/docs/index.rst
index c3f6164..1b54222 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,8 +1,3 @@
-.. TravisPy documentation master file, created by
- sphinx-quickstart on Wed Jul 2 10:35:41 2014.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
.. |travispy| replace:: **TravisPy**
.. |travisci| replace:: *Travis CI*
.. |github| replace:: *GitHub*
@@ -14,8 +9,9 @@
.. _entities: http://docs.travis-ci.com/api/#entities
.. _open issues: https://github.com/menegazzo/travispy/issues?state=open
-Introduction
-============
+========
+TravisPy
+========
.. automodule:: travispy
@@ -26,102 +22,15 @@ To install |travispy| all it takes is one command line::
pip install travispy
-Quick start
-===========
-
-|travispy| works just as |travisci|: it authenticates against |github|. So as a `requirement`_ you
-must have a |github| `access token`_ with the following scopes:
-
-* read:org
-* user:email
-* repo_deployment
-* repo:status
-* write:repo_hook
-
-With your token in hands all is easy::
-
- >>> from travispy import TravisPy
- >>> t = TravisPy.github_auth()
- >>> user = t.user()
- >>> user
-
-
-Now you can access information related to user current logged in::
-
- >>> user.login
- 'travispy'
- >>> user['login']
- 'travispy'
-
-To get the list of repositories that you are member of::
-
- >>> repos = t.repos(member=user.login)
- >>> len(repos) # Ordered by recent activity
- 5
- >>> repos[0]
-
- >>> repos[0].slug
- 'travispy/on_py34'
-
-Or simply request for repository you want::
-
- >>> repo = r.repo('travispy/on_py34')
-
-
-And finally, getting build information::
-
- >>> build = t.build(repo.last_build_id)
- >>> build
-
- >>> build.restart()
- True
- >>> build.cancel()
- True
- >>> build.cancel() # As build was already cancelled it will return False.
- False
-
-Please refer to the `official API`_ to learn more about which `entities`_ are supported. Soon a
-specific and detailed documentation related to this library will be available.
-
-Constants
-=========
-
-.. automodule:: travispy.travispy
- :no-members:
-
-Classes
-=======
-
-.. module:: travispy.travispy
-.. autoclass:: TravisPy
- :no-show-inheritance:
-
-.. autoclass:: Session
- :no-show-inheritance:
-
-.. module:: travispy.entities._entity
-.. autoclass:: Entity
- :no-show-inheritance:
-
-.. module:: travispy.entities._restartable
-.. autoclass:: Restartable
-
-.. module:: travispy.entities
-.. autoclass:: Account
-
-.. autoclass:: Broadcast
-
-.. autoclass:: Build
-
-.. autoclass:: Hook
-
-.. autoclass:: Job
-
-.. autoclass:: Log
-
-.. autoclass:: Repo
+Documentation
+=============
-.. autoclass:: User
+.. toctree::
+ :maxdepth: 2
+
+ getting_started
+ api
+ entities
Support
=======
