Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TaurusOlson committed Apr 17, 2019
1 parent 7a03b48 commit ddaab1f
Show file tree
Hide file tree
Showing 19 changed files with 1,376 additions and 32 deletions.
Binary file added docs/_build/doctrees/advanced_usage.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/api.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
16 changes: 16 additions & 0 deletions docs/_build/html/_sources/advanced_usage.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _advanced_usage:


Advanced usage
==============

Get the latest request and response
-----------------------------------

::
>>> api.seller.get_seller_information()
>>> api.latest_request
>>> api.latest_response


62 changes: 58 additions & 4 deletions docs/_build/html/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. _api:

API
===
Developer interface
===================

.. toctree::
:maxdepth: 2


.. module:: cdiscountapi
.. module:: cdiscountapi.cdiscountapi

Connection
----------
Expand All @@ -16,4 +16,58 @@ Connection
:members:
:inherited-members:

.. module:: cdiscountapi
Seller
------

.. autoclass:: Seller
:members:
:inherited-members:

Offers
------

.. autoclass:: Offers
:members:
:inherited-members:

Orders
------

.. autoclass:: Orders
:members:
:inherited-members:

Products
--------

.. autoclass:: Products
:members:
:inherited-members:

Relays
------

.. autoclass:: Relays
:members:
:inherited-members:

Fulfillment
-----------

.. autoclass:: Fulfillment
:members:
:inherited-members:

Discussions
-----------

.. autoclass:: Discussions
:members:
:inherited-members:

WebMail
-------

.. autoclass:: WebMail
:members:
:inherited-members:
1 change: 1 addition & 0 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Welcome to CdiscountAPI's documentation!

quickstart
api
advanced_usage
CHANGELOG


Expand Down
122 changes: 122 additions & 0 deletions docs/_build/html/advanced_usage.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Advanced usage &#8212; CdiscountAPI documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Change log" href="CHANGELOG.html" />
<link rel="prev" title="API" href="api.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<div class="section" id="advanced-usage">
<span id="id1"></span><h1>Advanced usage<a class="headerlink" href="#advanced-usage" title="Permalink to this headline"></a></h1>
<div class="section" id="get-the-latest-request-and-response">
<h2>Get the latest request and response<a class="headerlink" href="#get-the-latest-request-and-response" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">seller</span><span class="o">.</span><span class="n">get_seller_information</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">latest_request</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">latest_response</span>
</pre></div>
</div>
</div>
</div>


</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">CdiscountAPI</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Advanced usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#get-the-latest-request-and-response">Get the latest request and response</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Change log</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="api.html" title="previous chapter">API</a></li>
<li>Next: <a href="CHANGELOG.html" title="next chapter">Change log</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, ZIBOURA Mathilde, RABOIS Damien.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.0.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
<a href="_sources/advanced_usage.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
Loading

0 comments on commit ddaab1f

Please sign in to comment.