Skip to content

Commit 1a4fccd

Browse files
weakishweakish
authored
Merge pull request #467 from weakish/github-page-docs
docs: use github pages to host docs
2 parents 2e35711 + f36b8bd commit 1a4fccd

85 files changed

Lines changed: 27289 additions & 6 deletions

Some content is hidden

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

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ instance/
6262
.scrapy
6363

6464
# Sphinx documentation
65-
docs/_build/
65+
apidoc/_build/
6666

6767
# PyBuilder
6868
target/

‎README.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,15 @@ Maybe you need the `sudo` prefix depends on your OS environment.
2020

2121
## Generate API document
2222

23-
```bash
24-
cd docs
23+
Install dependencies:
24+
25+
```sh
26+
pip install Sphinx
27+
pip install sphinx_rtd_theme
28+
```
29+
30+
```sh
31+
cd apidoc
2532
make html
2633
```
2734

docs/Makefile renamed to apidoc/Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,10 @@ clean:
5353

5454
html:
5555
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56+
@rm -rf ../docs
57+
@mv $(BUILDDIR)/html ../docs
5658
@echo
57-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
59+
@echo "Build finished. The HTML pages are in ../docs."
5860

5961
dirhtml:
6062
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

docs/conf.py renamed to apidoc/conf.py

File renamed without changes.

docs/index.rst renamed to apidoc/index.rst

File renamed without changes.

docs/make.bat renamed to apidoc/make.bat

File renamed without changes.

‎docs/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: d3bc0ebdfe384fc2f27d81676702cb93
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_modules/index.html‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
2+
3+
<!DOCTYPE html>
4+
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
5+
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
6+
<head>
7+
<meta charset="utf-8">
8+
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
10+
11+
<title>概览：模块代码 &mdash; LeanCloud-Python-SDK 1.0.0 文档</title>
12+
13+
14+
15+
16+
17+
18+
19+
20+
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21+
22+
23+
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24+
<script src="../_static/jquery.js"></script>
25+
<script src="../_static/underscore.js"></script>
26+
<script src="../_static/doctools.js"></script>
27+
<script src="../_static/language_data.js"></script>
28+
<script src="../_static/translations.js"></script>
29+
30+
<script type="text/javascript" src="../_static/js/theme.js"></script>
31+
32+
33+
34+
35+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
36+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
37+
<link rel="index" title="索引" href="../genindex.html" />
38+
<link rel="search" title="搜索" href="../search.html" />
39+
</head>
40+
41+
<body class="wy-body-for-nav">
42+
43+
44+
<div class="wy-grid-for-nav">
45+
46+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
47+
<div class="wy-side-scroll">
48+
<div class="wy-side-nav-search" >
49+
50+
51+
52+
<a href="../index.html" class="icon icon-home"> LeanCloud-Python-SDK
53+
54+
55+
56+
</a>
57+
58+
59+
60+
61+
<div class="version">
62+
1.0.0
63+
</div>
64+
65+
66+
67+
68+
<div role="search">
69+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
70+
<input type="text" name="q" placeholder="Search docs" />
71+
<input type="hidden" name="check_keywords" value="yes" />
72+
<input type="hidden" name="area" value="default" />
73+
</form>
74+
</div>
75+
76+
77+
</div>
78+
79+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
80+
81+
82+
83+
84+
85+
86+
<!-- Local TOC -->
87+
<div class="local-toc"></div>
88+
89+
90+
</div>
91+
</div>
92+
</nav>
93+
94+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
95+
96+
97+
<nav class="wy-nav-top" aria-label="top navigation">
98+
99+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
100+
<a href="../index.html">LeanCloud-Python-SDK</a>
101+
102+
</nav>
103+
104+
105+
<div class="wy-nav-content">
106+
107+
<div class="rst-content">
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
118+
119+
120+
121+
122+
123+
124+
125+
<div role="navigation" aria-label="breadcrumbs navigation">
126+
127+
<ul class="wy-breadcrumbs">
128+
129+
<li><a href="../index.html">Docs</a> &raquo;</li>
130+
131+
<li>概览：模块代码</li>
132+
133+
134+
<li class="wy-breadcrumbs-aside">
135+
136+
</li>
137+
138+
</ul>
139+
140+
141+
<hr/>
142+
</div>
143+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
144+
<div itemprop="articleBody">
145+
146+
<h1>代码可用的所有模块</h1>
147+
<ul><li><a href="leancloud/acl.html">leancloud.acl</a></li>
148+
<li><a href="leancloud/client.html">leancloud.client</a></li>
149+
<li><a href="leancloud/cloud.html">leancloud.cloud</a></li>
150+
<li><a href="leancloud/engine.html">leancloud.engine</a></li>
151+
<ul><li><a href="leancloud/engine/cookie_session.html">leancloud.engine.cookie_session</a></li>
152+
<li><a href="leancloud/engine/https_redirect_middleware.html">leancloud.engine.https_redirect_middleware</a></li>
153+
</ul><li><a href="leancloud/errors.html">leancloud.errors</a></li>
154+
<li><a href="leancloud/file_.html">leancloud.file_</a></li>
155+
<li><a href="leancloud/geo_point.html">leancloud.geo_point</a></li>
156+
<li><a href="leancloud/object_.html">leancloud.object_</a></li>
157+
<li><a href="leancloud/push.html">leancloud.push</a></li>
158+
<li><a href="leancloud/query.html">leancloud.query</a></li>
159+
<li><a href="leancloud/relation.html">leancloud.relation</a></li>
160+
<li><a href="leancloud/role.html">leancloud.role</a></li>
161+
<li><a href="leancloud/user.html">leancloud.user</a></li>
162+
</ul>
163+
164+
</div>
165+
166+
</div>
167+
<footer>
168+
169+
170+
<hr/>
171+
172+
<div role="contentinfo">
173+
<p>
174+
&copy; Copyright 2015, asaka
175+
176+
</p>
177+
</div>
178+
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
179+
180+
</footer>
181+
182+
</div>
183+
</div>
184+
185+
</section>
186+
187+
</div>
188+
189+
190+
191+
<script type="text/javascript">
192+
jQuery(function () {
193+
SphinxRtdTheme.Navigation.enable(true);
194+
});
195+
</script>
196+
197+
198+
199+
200+
201+
202+
</body>
203+
</html>

0 commit comments

Comments
 (0)