Skip to content

Commit 39411bd

Browse files
seratchseratch
committed
Update the document generation process
1 parent f1f2697 commit 39411bd

File tree

137 files changed

+5349
-6806
lines changed

Some content is hidden

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

137 files changed

+5349
-6806
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ build/
33
dist/
44
docs/_sources/
55
docs/.doctrees
6+
docs-v2/_sources/
7+
docs-v2/.doctrees
68
.eggs/
79
*.egg-info/
810
*.egg

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Python Slack SDK (still in beta)
1+
# Python Slack SDK
22

33
The Slack platform offers several APIs to build apps. Each Slack API delivers part of the capabilities from the platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of Slack’s APIs. They are small and powerful when used independently, and work seamlessly when used together, too.
44

docs-src-v3/.gitignore renamed to docs-src-v2/.gitignore

File renamed without changes.

docs-src/Makefile renamed to docs-src-v2/Makefile

File renamed without changes.

docs-src-v3/_themes/slack/conf.py renamed to docs-src-v2/_themes/slack/conf.py

Lines changed: 34 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3131
# ones.
3232
extensions = [
33-
'sphinx.ext.autodoc',
34-
'sphinx.ext.coverage',
33+
'sphinx.ext.autodoc',
34+
'sphinx.ext.coverage',
3535
]
3636

3737
# Add any paths that contain templates here, relative to this directory.
@@ -51,8 +51,8 @@
5151
master_doc = 'index'
5252

5353
# General information about the project.
54-
project = u'Python Slack SDK'
55-
copyright = u'2015– Slack Technologies, Inc. and contributors'
54+
project = u'Slack Developer Kit for Python'
55+
copyright = u'2015–2016 Slack Technologies, Inc. and contributors'
5656
author = u'Slack Technologies, Inc. and contributors'
5757

5858
# The version info for the project you're documenting, acts as replacement for
@@ -83,14 +83,7 @@
8383
# List of patterns, relative to source directory, that match files and
8484
# directories to ignore when looking for source files.
8585
# This patterns also effect to html_static_path and html_extra_path
86-
exclude_patterns = [
87-
'_build',
88-
'Thumbs.db',
89-
'.DS_Store',
90-
'auth.rst',
91-
'basic_usage.rst',
92-
'conversations.rst',
93-
]
86+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
9487

9588
# The reST default role (used for this markup: `text`) to use for all
9689
# documents.
@@ -126,7 +119,7 @@
126119

127120
# -- Options for HTML output ----------------------------------------------
128121

129-
# The theme to use for HTML and HTML Help pages. See the documentation for
122+
# The theme to use for HTML and HTML Help pages. See the documentation for
130123
# a list of builtin themes.
131124
#
132125
html_theme = "slack"
@@ -135,7 +128,7 @@
135128
highlight_language = "python"
136129

137130
# Theme options are theme-specific and customize the look and feel of a theme
138-
# further. For a list of options available for each theme, see the
131+
# further. For a list of options available for each theme, see the
139132
# documentation.
140133
#
141134
# html_theme_options = {}
@@ -148,7 +141,7 @@
148141
#
149142
# html_title = u'python-slackclient v1.0.1'
150143

151-
# A shorter title for the navigation bar. Default is the same as html_title.
144+
# A shorter title for the navigation bar. Default is the same as html_title.
152145
#
153146
# html_short_title = None
154147

@@ -158,7 +151,7 @@
158151
# html_logo = None
159152

160153
# The name of an image file (relative to this directory) to use as a favicon of
161-
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
154+
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
162155
# pixels large.
163156
#
164157
# html_favicon = None
@@ -169,7 +162,7 @@
169162
html_static_path = ['static']
170163

171164
html_context = {
172-
'css_files': ['static/pygments.css'],
165+
'css_files': ['static/pygments.css'],
173166
}
174167

175168
# Add any extra paths that contain custom files (such as robots.txt or
@@ -223,7 +216,7 @@
223216
# html_show_copyright = True
224217

225218
# If true, an OpenSearch description file will be output, and all pages will
226-
# contain a <link> tag referring to it. The value of this option must be the
219+
# contain a <link> tag referring to it. The value of this option must be the
227220
# base URL from which the finished HTML is served.
228221
#
229222
# html_use_opensearch = ''
@@ -233,8 +226,8 @@
233226

234227
# Language to be used for generating the HTML full-text search index.
235228
# Sphinx supports the following languages:
236-
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
237-
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
229+
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
230+
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
238231
#
239232
# html_search_language = 'en'
240233

@@ -255,29 +248,29 @@
255248
# -- Options for LaTeX output ---------------------------------------------
256249

257250
latex_elements = {
258-
# The paper size ('letterpaper' or 'a4paper').
259-
#
260-
# 'papersize': 'letterpaper',
251+
# The paper size ('letterpaper' or 'a4paper').
252+
#
253+
# 'papersize': 'letterpaper',
261254

262-
# The font size ('10pt', '11pt' or '12pt').
263-
#
264-
# 'pointsize': '10pt',
255+
# The font size ('10pt', '11pt' or '12pt').
256+
#
257+
# 'pointsize': '10pt',
265258

266-
# Additional stuff for the LaTeX preamble.
267-
#
268-
# 'preamble': '',
259+
# Additional stuff for the LaTeX preamble.
260+
#
261+
# 'preamble': '',
269262

270-
# Latex figure (float) alignment
271-
#
272-
# 'figure_align': 'htbp',
263+
# Latex figure (float) alignment
264+
#
265+
# 'figure_align': 'htbp',
273266
}
274267

275268
# Grouping the document tree into LaTeX files. List of tuples
276269
# (source start file, target name, title,
277-
# author, documentclass [howto, manual, or own class]).
270+
# author, documentclass [howto, manual, or own class]).
278271
latex_documents = [
279-
(master_doc, 'python-slackclient.tex', u'python-slackclient Documentation',
280-
u'Ryan Huber, Jeff Ammons', 'manual'),
272+
(master_doc, 'python-slackclient.tex', u'python-slackclient Documentation',
273+
u'Ryan Huber, Jeff Ammons', 'manual'),
281274
]
282275

283276
# The name of an image file (relative to this directory) to place at the top of
@@ -312,8 +305,8 @@
312305
# One entry per manual page. List of tuples
313306
# (source start file, name, description, authors, manual section).
314307
man_pages = [
315-
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
316-
[author], 1)
308+
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
309+
[author], 1)
317310
]
318311

319312
# If true, show URL addresses after external links.
@@ -325,11 +318,11 @@
325318

326319
# Grouping the document tree into Texinfo files. List of tuples
327320
# (source start file, target name, title, author,
328-
# dir menu entry, description, category)
321+
# dir menu entry, description, category)
329322
texinfo_documents = [
330-
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
331-
author, 'python-slackclient', 'A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.',
332-
'Miscellaneous'),
323+
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
324+
author, 'python-slackclient', 'A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.',
325+
'Miscellaneous'),
333326
]
334327

335328
# Documents to append as an appendix to all manuals.

‎docs-src-v2/_themes/slack/layout.html‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta
5+
http-equiv="Content-Type"
6+
content="text/html; charset={{ encoding }}"
7+
/>
8+
{{
9+
metatags
10+
}}
11+
12+
{%- block htmltitle %}
13+
<title>{{ title|striptags|e + " &mdash; "|safe + project|e }}</title>
14+
{%- endblock %} {%- macro css() %}
15+
<link
16+
href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css"
17+
rel="stylesheet"
18+
type="text/css"
19+
/>
20+
<link
21+
href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css"
22+
rel="stylesheet"
23+
type="text/css"
24+
/>
25+
<link
26+
rel="stylesheet"
27+
href="{{ pathto('./_static/' + 'default.css', 1) }}"
28+
type="text/css"
29+
/>
30+
<link
31+
rel="stylesheet"
32+
href="{{ pathto('./_static/' + 'pygments.css', 1) }}"
33+
type="text/css"
34+
/>
35+
<link
36+
rel="stylesheet"
37+
href="{{ pathto('./_static/' + 'docs.css', 1) }}"
38+
type="text/css"
39+
/>
40+
{%- endmacro %}
41+
42+
<!-- Google Tag Manager -->
43+
<script>
44+
(function(w, d, s, l, i) {
45+
w[l] = w[l] || [];
46+
w[l].push({
47+
'gtm.start': new Date().getTime(),
48+
event: 'gtm.js'
49+
});
50+
var f = d.getElementsByTagName(s)[0],
51+
j = d.createElement(s),
52+
dl = l != 'dataLayer' ? '&l=' + l : '';
53+
j.async = true;
54+
j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
55+
f.parentNode.insertBefore(j, f);
56+
})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');
57+
</script>
58+
<!-- End Google Tag Manager -->
59+
{{
60+
css()
61+
}}
62+
{%- block linktags %}
63+
<link
64+
id="favicon"
65+
rel="shortcut icon"
66+
href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png"
67+
type="image/png"
68+
/>
69+
<link
70+
rel="top"
71+
title="{{ docstitle | e }}"
72+
href="{{ pathto(master_doc) }}"
73+
/>
74+
{%- endblock %}
75+
</head>
76+
77+
<body class="api light_theme">
78+
<!-- Google Tag Manager (noscript) -->
79+
<noscript
80+
><iframe
81+
src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7"
82+
height="0"
83+
width="0"
84+
style="display:none;visibility:hidden"
85+
></iframe
86+
></noscript>
87+
<!-- End Google Tag Manager (noscript) -->
88+
89+
{%- block header %}
90+
<header>
91+
<a id="menu_toggle" class="no_transition show_on_mobile">
92+
<span class="menu_icon"></span>
93+
<span class="vert_divider"></span>
94+
</a>
95+
<a
96+
href="https://api.slack.com/"
97+
id="header_logo"
98+
class="api hide_on_mobile"
99+
style="float:left; display: inline-block;"
100+
>
101+
<img
102+
alt="Slack API"
103+
src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png"
104+
style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;"
105+
/>
106+
</a>
107+
<span
108+
style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;"
109+
>
110+
<a style="color: #555459;" href="./index.html">{{ project }}</a>
111+
</span>
112+
<div class="header_nav">
113+
<a
114+
href="https://github.com/SlackAPI/python-slackclient"
115+
class="btn header_btn float_right"
116+
data-qa="go_to_slack"
117+
>Go to GitHub</a
118+
>
119+
</div>
120+
</header>
121+
{% endblock %}
122+
123+
<div id="page">
124+
<div id="page_contents" class="clearfix">
125+
<!-- Sidebar Content -->
126+
<nav id="api_nav" class="col span_1_of_4">
127+
<div id="api_sections">
128+
{% block sidebar %} {% include 'sidebar.html' %} {% endblock %}
129+
</div>
130+
</nav>
131+
<!-- /Sidebar Content -->
132+
133+
<!-- Body Content -->
134+
<div class="col span_3_of_4">
135+
<!-- <div class="section-title">{{ title }}</div> -->
136+
<div class="card">
137+
{%- block body %}
138+
{{ body }}
139+
{% endblock %}
140+
<div class="clear_both large_bottom_margin"></div>
141+
</div>
142+
</div>
143+
<!-- /Body Content -->
144+
</div>
145+
</div>
146+
147+
<footer>
148+
<p class="light tiny align_center">
149+
© 2020 Slack Technologies, Inc. and contributors
150+
</p>
151+
</footer>
152+
153+
<script>
154+
window.ga =
155+
window.ga ||
156+
function() {
157+
(ga.q = ga.q || []).push(arguments);
158+
};
159+
ga.l = +new Date();
160+
ga('create', 'UA-56978219-13', 'auto');
161+
ga('send', 'pageview');
162+
</script>
163+
<script async src="https://www.google-analytics.com/analytics.js"></script>
164+
</body>
165+
</html>

docs-src-v3/_themes/slack/localtoc.html renamed to docs-src-v2/_themes/slack/localtoc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<h5>Table of Contents?</h5>
22
<ul class="localtoc">
3-
{{ toc }}
3+
{{ toc }}
44
</ul>

‎docs-src-v2/_themes/slack/relations.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{#
2+
basic/relations.html
3+
~~~~~~~~~~~~~~~~~~~~
4+
5+
Sphinx sidebar template: relation links.
6+
7+
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
8+
:license: BSD, see LICENSE for details.
9+
#}
10+
{%- if prev %}
11+
<h4>{{ _('Previous topic') }}</h4>
12+
<p class="topless"><a href="{{ prev.link|e }}"
13+
title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
14+
{%- endif %}
15+
{%- if next %}
16+
<h4>{{ _('Next topic') }}</h4>
17+
<p class="topless"><a href="{{ next.link|e }}"
18+
title="{{ _('next chapter') }}">{{ next.title }}</a></p>
19+
{%- endif %}

‎docs-src-v2/_themes/slack/sidebar.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{{ toctree(maxdepth=-1, collapse=False,includehidden=True) }}
2+
3+
<div id="footer">
4+
5+
<ul id="footer_nav">
6+
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/main/LICENSE">License</a></li>
7+
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
8+
<li><a href="https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md">Contributing</a></li>
9+
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
10+
</ul>
11+
12+
<p id="footer_signature">Made with <i class="ts_icon ts_icon_heart"></i> by Slack<br/>and our Lovely
13+
Community
14+
</p>
15+
</div>

0 commit comments

Comments
 (0)