Skip to content

Commit db96ef4

Browse files
authored
Merge pull request #89 from livechat/API-8792-use-pdoc-generated-main-docs-page
API-8792: Use pdoc generated main page and full documentation structure
2 parents fe46d39 + a4230fb commit db96ef4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1718
-7323
lines changed

README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,11 @@
22

33
This Software Development Kit written in Python3 helps developers build external backend apps that extend LiveChat features. The SDK makes it easy to use Agent Chat API, Customer Chat API and Configuration API.
44

5-
## API protocol docs
5+
## Documentation
66

7-
For protocol documentation of LiveChat APIs, please go to [Livechat Platform Docs](https://developers.livechatinc.com/docs/).
7+
For protocol documentation of LiveChat APIs, please go to [LiveChat Platform Docs](https://developers.livechatinc.com/docs/).
88

9-
## Technical docs
10-
11-
Agent Chat API:
12-
* [RTM API](https://livechat.github.io/lc-sdk-python/agent_rtm/index.html)
13-
* [WEB API](https://livechat.github.io/lc-sdk-python/agent_web/index.html)
14-
15-
Customer Chat API:
16-
* [RTM API](https://livechat.github.io/lc-sdk-python/customer_rtm/index.html)
17-
* [WEB API](https://livechat.github.io/lc-sdk-python/customer_web/index.html)
18-
19-
Management:
20-
* [Configuration API](https://livechat.github.io/lc-sdk-python/configuration/index.html)
21-
22-
Reports:
23-
* [Reports API](https://livechat.github.io/lc-sdk-python/reports/index.html)
9+
For internal documentation of the SDK, please check: [Technical documentation](https://livechat.github.io/lc-sdk-python/docs/index.html).
2410

2511
## Installation
2612

changelog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ All notable changes to this project will be documented in this file.
1616
- Fix paths for `response_time` and `first_response_time` methods in reports-api v3.4/v3.5 classes.
1717
- Fix `upload_file` method in agent-api v3.4/v3.5 classes.
1818

19+
### Changed
20+
- Internal documentation main page and structure.
21+
1922
### Removed
2023
- Support for `list_group_properties`, `get_license_id` and `get_organization_id` method in configuration-api v3.5 class.
2124
- Support for `webhook` parameter in `create_bot` and `update_bot` methods in configuration-api v3.3/v3.4/v3.5 classes.

docs/agent/index.html

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.10.0" />
7+
<title>livechat.agent API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>livechat.agent</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<details class="source">
26+
<summary>
27+
<span>Expand source code</span>
28+
</summary>
29+
<pre><code class="python"># pylint: disable=C0114
30+
from livechat.agent.rtm.base import AgentRTM
31+
from livechat.agent.web.base import AgentWeb</code></pre>
32+
</details>
33+
</section>
34+
<section>
35+
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
36+
<dl>
37+
<dt><code class="name"><a title="livechat.agent.rtm" href="rtm/index.html">livechat.agent.rtm</a></code></dt>
38+
<dd>
39+
<div class="desc"></div>
40+
</dd>
41+
<dt><code class="name"><a title="livechat.agent.web" href="web/index.html">livechat.agent.web</a></code></dt>
42+
<dd>
43+
<div class="desc"></div>
44+
</dd>
45+
</dl>
46+
</section>
47+
<section>
48+
</section>
49+
<section>
50+
</section>
51+
<section>
52+
</section>
53+
</article>
54+
<nav id="sidebar">
55+
<h1>Index</h1>
56+
<div class="toc">
57+
<ul></ul>
58+
</div>
59+
<ul id="index">
60+
<li><h3>Super-module</h3>
61+
<ul>
62+
<li><code><a title="livechat" href="../index.html">livechat</a></code></li>
63+
</ul>
64+
</li>
65+
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
66+
<ul>
67+
<li><code><a title="livechat.agent.rtm" href="rtm/index.html">livechat.agent.rtm</a></code></li>
68+
<li><code><a title="livechat.agent.web" href="web/index.html">livechat.agent.web</a></code></li>
69+
</ul>
70+
</li>
71+
</ul>
72+
</nav>
73+
</main>
74+
<footer id="footer">
75+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
76+
</footer>
77+
</body>
78+
</html>

docs/agent_rtm/api/index.html renamed to docs/agent/rtm/api/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
66
<meta name="generator" content="pdoc 0.10.0" />
7-
<title>rtm.api API documentation</title>
7+
<title>livechat.agent.rtm.api API documentation</title>
88
<meta name="description" content="" />
99
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
1010
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
@@ -19,22 +19,22 @@
1919
<main>
2020
<article id="content">
2121
<header>
22-
<h1 class="title">Namespace <code>rtm.api</code></h1>
22+
<h1 class="title">Module <code>livechat.agent.rtm.api</code></h1>
2323
</header>
2424
<section id="section-intro">
2525
</section>
2626
<section>
2727
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
2828
<dl>
29-
<dt><code class="name"><a title="rtm.api.v33" href="v33.html">rtm.api.v33</a></code></dt>
29+
<dt><code class="name"><a title="livechat.agent.rtm.api.v33" href="v33.html">livechat.agent.rtm.api.v33</a></code></dt>
3030
<dd>
3131
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.3.</p></div>
3232
</dd>
33-
<dt><code class="name"><a title="rtm.api.v34" href="v34.html">rtm.api.v34</a></code></dt>
33+
<dt><code class="name"><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></dt>
3434
<dd>
3535
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.4.</p></div>
3636
</dd>
37-
<dt><code class="name"><a title="rtm.api.v35" href="v35.html">rtm.api.v35</a></code></dt>
37+
<dt><code class="name"><a title="livechat.agent.rtm.api.v35" href="v35.html">livechat.agent.rtm.api.v35</a></code></dt>
3838
<dd>
3939
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.5.</p></div>
4040
</dd>
@@ -55,14 +55,14 @@ <h1>Index</h1>
5555
<ul id="index">
5656
<li><h3>Super-module</h3>
5757
<ul>
58-
<li><code><a title="rtm" href="../index.html">rtm</a></code></li>
58+
<li><code><a title="livechat.agent.rtm" href="../index.html">livechat.agent.rtm</a></code></li>
5959
</ul>
6060
</li>
6161
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
6262
<ul>
63-
<li><code><a title="rtm.api.v33" href="v33.html">rtm.api.v33</a></code></li>
64-
<li><code><a title="rtm.api.v34" href="v34.html">rtm.api.v34</a></code></li>
65-
<li><code><a title="rtm.api.v35" href="v35.html">rtm.api.v35</a></code></li>
63+
<li><code><a title="livechat.agent.rtm.api.v33" href="v33.html">livechat.agent.rtm.api.v33</a></code></li>
64+
<li><code><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></li>
65+
<li><code><a title="livechat.agent.rtm.api.v35" href="v35.html">livechat.agent.rtm.api.v35</a></code></li>
6666
</ul>
6767
</li>
6868
</ul>

0 commit comments

Comments
 (0)