github/sprockets.clients.http
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.clients.http.git synced 2024-11-15 03:00:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Polish the documentation a little.

Browse source
This commit is contained in:
Dave Shawley 2016-02-28 09:00:15 -05:00
parent b8843a425a
commit 0c972ce6c2
4 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/api.rst
View file

@ -1,8 +1,5 @@
Reference Documentation Reference Documentation
======================= =======================
.. automodule:: sprockets.clients.http.client .. automodule:: sprockets.clients.http
:members:
.. automodule:: sprockets.clients.http.mixins
:members: :members:

1
docs/conf.py
View file

@ -33,6 +33,7 @@ html_theme_options = {
'description': 'HTTP API client', 'description': 'HTTP API client',
'github_banner': True, 'github_banner': True,
'travis_button': True, 'travis_button': True,
'codecov_button': True,
} }
intersphinx_mapping = { intersphinx_mapping = {

12
docs/history.rst Normal file
View file

@ -0,0 +1,12 @@
.. :changelog:
Release History
===============
`Next Release`_
---------------
- Add :class:`sprockets.clients.http.HTTPClient`
- Add :class:`sprockets.clients.http.ClientMixin`
- Add :class:`sprockets.clients.http.HTTPError`
.. _Next Release: https://github.com/sprockets/sprockets.clients.http/compare/0.0.0...master

2
docs/index.rst
View file

@ -1,8 +1,8 @@
.. include:: ../README.rst .. include:: ../README.rst
.. toctree:: .. toctree::
:maxdepth: 2
:hidden: :hidden:
api api
examples examples
history