Skip to content

Commit 90c7b81

Browse files
tapestry-aang01tapestry-aang01
committed
Update docs
1 parent f3aff7b commit 90c7b81

23 files changed

+12051
-500
lines changed

‎docs/_source/conf.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
3333
extensions = ['sphinx.ext.autodoc',
34-
# 'sphinx.ext.viewcode',
34+
'sphinx.ext.viewcode',
3535
'sphinx.ext.githubpages']
3636

3737
# Add any paths that contain templates here, relative to this directory.
@@ -48,7 +48,7 @@
4848

4949
# General information about the project.
5050
project = u'gdocrevisions'
51-
copyright = u'2017, President and Fellows of Harvard College'
51+
copyright = u'2018, President and Fellows of Harvard College'
5252
author = u'Andrew Ang'
5353

5454
# The version info for the project you're documenting, acts as replacement for
@@ -84,7 +84,7 @@
8484
# The theme to use for HTML and HTML Help pages. See the documentation for
8585
# a list of builtin themes.
8686
#
87-
html_theme = 'alabaster'
87+
html_theme = 'nature'
8888

8989
# Theme options are theme-specific and customize the look and feel of a theme
9090
# further. For a list of options available for each theme, see the
@@ -155,4 +155,6 @@
155155
]
156156

157157

158-
158+
# -- Options for autoclass behavior ---------------------------------------
159+
# Both the class’ and the __init__ method’s docstring are concatenated and inserted.
160+
autoclass_content = 'both'

‎docs/docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: ade53b7a075a597f39d2d491939313d9
3+
config: 38fcc3164de563b2a79cbdc881094deb
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/docs/_modules/gdocrevisions/document.html‎

Lines changed: 323 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/docs/_modules/gdocrevisions/element.html‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9+
<title>gdocrevisions.element &#8212; gdocrevisions 0.5.1 documentation</title>
10+
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
11+
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
12+
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
13+
<script type="text/javascript" src="../../_static/jquery.js"></script>
14+
<script type="text/javascript" src="../../_static/underscore.js"></script>
15+
<script type="text/javascript" src="../../_static/doctools.js"></script>
16+
<link rel="index" title="Index" href="../../genindex.html" />
17+
<link rel="search" title="Search" href="../../search.html" />
18+
</head><body>
19+
<div class="related" role="navigation" aria-label="related navigation">
20+
<h3>Navigation</h3>
21+
<ul>
22+
<li class="right" style="margin-right: 10px">
23+
<a href="../../genindex.html" title="General Index"
24+
accesskey="I">index</a></li>
25+
<li class="right" >
26+
<a href="../../py-modindex.html" title="Python Module Index"
27+
>modules</a> |</li>
28+
<li class="nav-item nav-item-0"><a href="../../index.html">gdocrevisions 0.5.1 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
30+
</ul>
31+
</div>
32+
33+
<div class="document">
34+
<div class="documentwrapper">
35+
<div class="bodywrapper">
36+
<div class="body" role="main">
37+
38+
<h1>Source code for gdocrevisions.element</h1><div class="highlight"><pre>
39+
<span></span><span class="c1"># constants for suggestion status</span>
40+
<span class="n">SUGGEST_INSERT</span> <span class="o">=</span> <span class="mi">1</span>
41+
<span class="n">SUGGEST_DELETE</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
42+
<span class="n">SUGGEST_NONE</span> <span class="o">=</span> <span class="mi">0</span>
43+
44+
45+
<div class="viewcode-block" id="Element"><a class="viewcode-back" href="../../gdocrevisions.html#gdocrevisions.element.Element">[docs]</a><span class="k">class</span> <span class="nc">Element</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
46+
<span class="sd">&quot;&quot;&quot;</span>
47+
<span class="sd"> Base Element class. </span>
48+
<span class="sd"> Is a list element in a document&#39;s content attribute.</span>
49+
<span class="sd"> Associated with a revision</span>
50+
<span class="sd"> Suggest attribute denotes whether element is suggested for insertion (1), suggested for</span>
51+
<span class="sd"> deletion (-1), or not part of a suggestion (0).</span>
52+
<span class="sd"> &quot;&quot;&quot;</span>
53+
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;revision&#39;</span><span class="p">,</span> <span class="s1">&#39;suggest&#39;</span><span class="p">)</span>
54+
55+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">revision</span><span class="p">,</span> <span class="n">suggest</span><span class="o">=</span><span class="n">SUGGEST_NONE</span><span class="p">):</span>
56+
<span class="bp">self</span><span class="o">.</span><span class="n">revision</span> <span class="o">=</span> <span class="n">revision</span>
57+
<span class="bp">self</span><span class="o">.</span><span class="n">suggest</span> <span class="o">=</span> <span class="n">suggest</span>
58+
59+
<div class="viewcode-block" id="Element.render"><a class="viewcode-back" href="../../gdocrevisions.html#gdocrevisions.element.Element.render">[docs]</a> <span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
60+
<span class="k">return</span> <span class="s2">&quot;&quot;</span></div></div>
61+
62+
63+
<div class="viewcode-block" id="Character"><a class="viewcode-back" href="../../gdocrevisions.html#gdocrevisions.element.Character">[docs]</a><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">Element</span><span class="p">):</span>
64+
<span class="sd">&quot;&quot;&quot;</span>
65+
<span class="sd"> Character element</span>
66+
<span class="sd"> Represents a single character</span>
67+
<span class="sd"> &quot;&quot;&quot;</span>
68+
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;char&#39;</span><span class="p">,</span> <span class="s1">&#39;revision_insert&#39;</span><span class="p">,</span> <span class="s1">&#39;revision_delete&#39;</span><span class="p">,</span> <span class="s1">&#39;suggest&#39;</span><span class="p">)</span>
69+
70+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">char</span><span class="p">,</span> <span class="n">revision</span><span class="p">,</span> <span class="n">suggest</span><span class="o">=</span><span class="n">SUGGEST_NONE</span><span class="p">):</span>
71+
<span class="c1"># character string</span>
72+
<span class="bp">self</span><span class="o">.</span><span class="n">char</span> <span class="o">=</span> <span class="n">char</span>
73+
<span class="c1"># revision in which element is created</span>
74+
<span class="bp">self</span><span class="o">.</span><span class="n">revision_insert</span> <span class="o">=</span> <span class="n">revision</span>
75+
<span class="c1"># placeholder for revision in which element is deleted</span>
76+
<span class="bp">self</span><span class="o">.</span><span class="n">revision_delete</span> <span class="o">=</span> <span class="kc">None</span>
77+
<span class="c1"># indicator whether this is a suggestion, can take values -1, 0, or 1</span>
78+
<span class="bp">self</span><span class="o">.</span><span class="n">suggest</span> <span class="o">=</span> <span class="n">suggest</span>
79+
80+
<span class="nd">@property</span>
81+
<span class="k">def</span> <span class="nf">revision</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
82+
<span class="sd">&quot;&quot;&quot;</span>
83+
<span class="sd"> Alias for revision_insert attribute</span>
84+
<span class="sd"> &quot;&quot;&quot;</span>
85+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">revision_insert</span>
86+
87+
<div class="viewcode-block" id="Character.render"><a class="viewcode-back" href="../../gdocrevisions.html#gdocrevisions.element.Character.render">[docs]</a> <span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
88+
<span class="sd">&quot;&quot;&quot;</span>
89+
<span class="sd"> Render this element, typically called by content.render()</span>
90+
<span class="sd"> &quot;&quot;&quot;</span>
91+
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggest</span> <span class="o">==</span> <span class="n">SUGGEST_DELETE</span><span class="p">:</span>
92+
<span class="k">return</span> <span class="sa">u</span><span class="s1">&#39;</span><span class="si">{}</span><span class="se">\u0336</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char</span><span class="p">)</span>
93+
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggest</span> <span class="o">==</span> <span class="n">SUGGEST_INSERT</span><span class="p">:</span>
94+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">char</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
95+
<span class="k">else</span><span class="p">:</span>
96+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">char</span></div></div>
97+
98+
99+
<div class="viewcode-block" id="EndOfBody"><a class="viewcode-back" href="../../gdocrevisions.html#gdocrevisions.element.EndOfBody">[docs]</a><span class="k">class</span> <span class="nc">EndOfBody</span><span class="p">(</span><span class="n">Element</span><span class="p">):</span>
100+
<span class="sd">&quot;&quot;&quot;</span>
101+
<span class="sd"> Dummy element indicating end of document body</span>
102+
<span class="sd"> Separates main content from footnote text</span>
103+
<span class="sd"> &quot;&quot;&quot;</span>
104+
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">()</span>
105+
106+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
107+
<span class="k">pass</span></div>
108+
</pre></div>
109+
110+
</div>
111+
</div>
112+
</div>
113+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
114+
<div class="sphinxsidebarwrapper">
115+
<div id="searchbox" style="display: none" role="search">
116+
<h3>Quick search</h3>
117+
<div class="searchformwrapper">
118+
<form class="search" action="../../search.html" method="get">
119+
<input type="text" name="q" />
120+
<input type="submit" value="Go" />
121+
<input type="hidden" name="check_keywords" value="yes" />
122+
<input type="hidden" name="area" value="default" />
123+
</form>
124+
</div>
125+
</div>
126+
<script type="text/javascript">$('#searchbox').show(0);</script>
127+
</div>
128+
</div>
129+
<div class="clearer"></div>
130+
</div>
131+
<div class="related" role="navigation" aria-label="related navigation">
132+
<h3>Navigation</h3>
133+
<ul>
134+
<li class="right" style="margin-right: 10px">
135+
<a href="../../genindex.html" title="General Index"
136+
>index</a></li>
137+
<li class="right" >
138+
<a href="../../py-modindex.html" title="Python Module Index"
139+
>modules</a> |</li>
140+
<li class="nav-item nav-item-0"><a href="../../index.html">gdocrevisions 0.5.1 documentation</a> &#187;</li>
141+
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
142+
</ul>
143+
</div>
144+
<div class="footer" role="contentinfo">
145+
&#169; Copyright 2018, President and Fellows of Harvard College.
146+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.6.
147+
</div>
148+
</body>
149+
</html>

0 commit comments

Comments
 (0)