diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/commands.rst | 48 | ||||
-rw-r--r-- | docs/conf.py | 242 | ||||
-rw-r--r-- | docs/index.rst | 24 | ||||
-rw-r--r-- | docs/using_tox.rst | 64 |
4 files changed, 378 insertions, 0 deletions
diff --git a/docs/commands.rst b/docs/commands.rst new file mode 100644 index 00000000..ab7e60d1 --- /dev/null +++ b/docs/commands.rst | |||
@@ -0,0 +1,48 @@ | |||
1 | Tox User Commands | ||
2 | ================= | ||
3 | |||
4 | Here's a list of commands that nTox accepts, which can all be used by | ||
5 | starting your line with a */*. Currently there can be no spaces before | ||
6 | this. | ||
7 | |||
8 | - */f* [ID] | ||
9 | |||
10 | - Add a friend with ID [ID]. | ||
11 | |||
12 | - */d* | ||
13 | |||
14 | - Call doMessenger() which does...something? | ||
15 | |||
16 | - */m* [FRIEND\_NUM] [MESSAGE] | ||
17 | |||
18 | - Message [FRIEND\_NUM] [MESSAGE]. | ||
19 | |||
20 | - */n* [NAME] | ||
21 | |||
22 | - Change your username to [NAME]. | ||
23 | |||
24 | - */l* | ||
25 | |||
26 | - Print your list of friends. (like you have any) | ||
27 | |||
28 | - */s* [STATUS] | ||
29 | |||
30 | - Set your status to [STATUS]. | ||
31 | |||
32 | - */a* [ID] | ||
33 | |||
34 | - Accept friend request from [ID]. | ||
35 | |||
36 | - */i* | ||
37 | |||
38 | - Print useful info about your client. | ||
39 | |||
40 | - */h* | ||
41 | |||
42 | - Print some help. | ||
43 | |||
44 | - */q/* | ||
45 | |||
46 | - Quit Tox. (why ;\_;) | ||
47 | |||
48 | |||
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..afebb632 --- /dev/null +++ b/docs/conf.py | |||
@@ -0,0 +1,242 @@ | |||
1 | # -*- coding: utf-8 -*- | ||
2 | # | ||
3 | # ProjectTox documentation build configuration file, created by | ||
4 | # sphinx-quickstart on Wed Jul 31 23:07:35 2013. | ||
5 | # | ||
6 | # This file is execfile()d with the current directory set to its containing dir. | ||
7 | # | ||
8 | # Note that not all possible configuration values are present in this | ||
9 | # autogenerated file. | ||
10 | # | ||
11 | # All configuration values have a default; values that are commented out | ||
12 | # serve to show the default. | ||
13 | |||
14 | import sys, os | ||
15 | |||
16 | # If extensions (or modules to document with autodoc) are in another directory, | ||
17 | # add these directories to sys.path here. If the directory is relative to the | ||
18 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
19 | #sys.path.insert(0, os.path.abspath('.')) | ||
20 | |||
21 | # -- General configuration ----------------------------------------------------- | ||
22 | |||
23 | # If your documentation needs a minimal Sphinx version, state it here. | ||
24 | #needs_sphinx = '1.0' | ||
25 | |||
26 | # Add any Sphinx extension module names here, as strings. They can be extensions | ||
27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
28 | extensions = [] | ||
29 | |||
30 | # Add any paths that contain templates here, relative to this directory. | ||
31 | templates_path = ['_templates'] | ||
32 | |||
33 | # The suffix of source filenames. | ||
34 | source_suffix = '.rst' | ||
35 | |||
36 | # The encoding of source files. | ||
37 | #source_encoding = 'utf-8-sig' | ||
38 | |||
39 | # The master toctree document. | ||
40 | master_doc = 'index' | ||
41 | |||
42 | # General information about the project. | ||
43 | project = u'ProjectTox' | ||
44 | copyright = u'2013, Tox Team' | ||
45 | |||
46 | # The version info for the project you're documenting, acts as replacement for | ||
47 | # |version| and |release|, also used in various other places throughout the | ||
48 | # built documents. | ||
49 | # | ||
50 | # The short X.Y version. | ||
51 | version = '0.1' | ||
52 | # The full version, including alpha/beta/rc tags. | ||
53 | release = '0.1' | ||
54 | |||
55 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
56 | # for a list of supported languages. | ||
57 | #language = None | ||
58 | |||
59 | # There are two options for replacing |today|: either, you set today to some | ||
60 | # non-false value, then it is used: | ||
61 | #today = '' | ||
62 | # Else, today_fmt is used as the format for a strftime call. | ||
63 | #today_fmt = '%B %d, %Y' | ||
64 | |||
65 | # List of patterns, relative to source directory, that match files and | ||
66 | # directories to ignore when looking for source files. | ||
67 | exclude_patterns = ['_build'] | ||
68 | |||
69 | # The reST default role (used for this markup: `text`) to use for all documents. | ||
70 | #default_role = None | ||
71 | |||
72 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
73 | #add_function_parentheses = True | ||
74 | |||
75 | # If true, the current module name will be prepended to all description | ||
76 | # unit titles (such as .. function::). | ||
77 | #add_module_names = True | ||
78 | |||
79 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
80 | # output. They are ignored by default. | ||
81 | #show_authors = False | ||
82 | |||
83 | # The name of the Pygments (syntax highlighting) style to use. | ||
84 | pygments_style = 'sphinx' | ||
85 | |||
86 | # A list of ignored prefixes for module index sorting. | ||
87 | #modindex_common_prefix = [] | ||
88 | |||
89 | |||
90 | # -- Options for HTML output --------------------------------------------------- | ||
91 | |||
92 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
93 | # a list of builtin themes. | ||
94 | html_theme = 'default' | ||
95 | |||
96 | # Theme options are theme-specific and customize the look and feel of a theme | ||
97 | # further. For a list of options available for each theme, see the | ||
98 | # documentation. | ||
99 | #html_theme_options = {} | ||
100 | |||
101 | # Add any paths that contain custom themes here, relative to this directory. | ||
102 | #html_theme_path = [] | ||
103 | |||
104 | # The name for this set of Sphinx documents. If None, it defaults to | ||
105 | # "<project> v<release> documentation". | ||
106 | #html_title = None | ||
107 | |||
108 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
109 | #html_short_title = None | ||
110 | |||
111 | # The name of an image file (relative to this directory) to place at the top | ||
112 | # of the sidebar. | ||
113 | #html_logo = None | ||
114 | |||
115 | # The name of an image file (within the static path) to use as favicon of the | ||
116 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
117 | # pixels large. | ||
118 | #html_favicon = None | ||
119 | |||
120 | # Add any paths that contain custom static files (such as style sheets) here, | ||
121 | # relative to this directory. They are copied after the builtin static files, | ||
122 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
123 | html_static_path = ['_static'] | ||
124 | |||
125 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
126 | # using the given strftime format. | ||
127 | #html_last_updated_fmt = '%b %d, %Y' | ||
128 | |||
129 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
130 | # typographically correct entities. | ||
131 | #html_use_smartypants = True | ||
132 | |||
133 | # Custom sidebar templates, maps document names to template names. | ||
134 | #html_sidebars = {} | ||
135 | |||
136 | # Additional templates that should be rendered to pages, maps page names to | ||
137 | # template names. | ||
138 | #html_additional_pages = {} | ||
139 | |||
140 | # If false, no module index is generated. | ||
141 | #html_domain_indices = True | ||
142 | |||
143 | # If false, no index is generated. | ||
144 | #html_use_index = True | ||
145 | |||
146 | # If true, the index is split into individual pages for each letter. | ||
147 | #html_split_index = False | ||
148 | |||
149 | # If true, links to the reST sources are added to the pages. | ||
150 | #html_show_sourcelink = True | ||
151 | |||
152 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
153 | #html_show_sphinx = True | ||
154 | |||
155 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
156 | #html_show_copyright = True | ||
157 | |||
158 | # If true, an OpenSearch description file will be output, and all pages will | ||
159 | # contain a <link> tag referring to it. The value of this option must be the | ||
160 | # base URL from which the finished HTML is served. | ||
161 | #html_use_opensearch = '' | ||
162 | |||
163 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
164 | #html_file_suffix = None | ||
165 | |||
166 | # Output file base name for HTML help builder. | ||
167 | htmlhelp_basename = 'ProjectToxdoc' | ||
168 | |||
169 | |||
170 | # -- Options for LaTeX output -------------------------------------------------- | ||
171 | |||
172 | latex_elements = { | ||
173 | # The paper size ('letterpaper' or 'a4paper'). | ||
174 | #'papersize': 'letterpaper', | ||
175 | |||
176 | # The font size ('10pt', '11pt' or '12pt'). | ||
177 | #'pointsize': '10pt', | ||
178 | |||
179 | # Additional stuff for the LaTeX preamble. | ||
180 | #'preamble': '', | ||
181 | } | ||
182 | |||
183 | # Grouping the document tree into LaTeX files. List of tuples | ||
184 | # (source start file, target name, title, author, documentclass [howto/manual]). | ||
185 | latex_documents = [ | ||
186 | ('index', 'ProjectTox.tex', u'ProjectTox Documentation', | ||
187 | u'Tox Team', 'manual'), | ||
188 | ] | ||
189 | |||
190 | # The name of an image file (relative to this directory) to place at the top of | ||
191 | # the title page. | ||
192 | #latex_logo = None | ||
193 | |||
194 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
195 | # not chapters. | ||
196 | #latex_use_parts = False | ||
197 | |||
198 | # If true, show page references after internal links. | ||
199 | #latex_show_pagerefs = False | ||
200 | |||
201 | # If true, show URL addresses after external links. | ||
202 | #latex_show_urls = False | ||
203 | |||
204 | # Documents to append as an appendix to all manuals. | ||
205 | #latex_appendices = [] | ||
206 | |||
207 | # If false, no module index is generated. | ||
208 | #latex_domain_indices = True | ||
209 | |||
210 | |||
211 | # -- Options for manual page output -------------------------------------------- | ||
212 | |||
213 | # One entry per manual page. List of tuples | ||
214 | # (source start file, name, description, authors, manual section). | ||
215 | man_pages = [ | ||
216 | ('index', 'projecttox', u'ProjectTox Documentation', | ||
217 | [u'Tox Team'], 1) | ||
218 | ] | ||
219 | |||
220 | # If true, show URL addresses after external links. | ||
221 | #man_show_urls = False | ||
222 | |||
223 | |||
224 | # -- Options for Texinfo output ------------------------------------------------ | ||
225 | |||
226 | # Grouping the document tree into Texinfo files. List of tuples | ||
227 | # (source start file, target name, title, author, | ||
228 | # dir menu entry, description, category) | ||
229 | texinfo_documents = [ | ||
230 | ('index', 'ProjectTox', u'ProjectTox Documentation', | ||
231 | u'Tox Team', 'ProjectTox', 'One line description of project.', | ||
232 | 'Miscellaneous'), | ||
233 | ] | ||
234 | |||
235 | # Documents to append as an appendix to all manuals. | ||
236 | #texinfo_appendices = [] | ||
237 | |||
238 | # If false, no module index is generated. | ||
239 | #texinfo_domain_indices = True | ||
240 | |||
241 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
242 | #texinfo_show_urls = 'footnote' | ||
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..5233f4ca --- /dev/null +++ b/docs/index.rst | |||
@@ -0,0 +1,24 @@ | |||
1 | .. ProjectTox documentation master file, created by | ||
2 | sphinx-quickstart on Wed Jul 31 23:07:35 2013. | ||
3 | You can adapt this file completely to your liking, but it should at least | ||
4 | contain the root `toctree` directive. | ||
5 | |||
6 | Welcome to ProjectTox's documentation! | ||
7 | ====================================== | ||
8 | |||
9 | Contents: | ||
10 | |||
11 | .. toctree:: | ||
12 | commands.rst | ||
13 | using_tox.rst | ||
14 | :maxdepth: 2 | ||
15 | |||
16 | |||
17 | |||
18 | Indices and tables | ||
19 | ================== | ||
20 | |||
21 | * :ref:`genindex` | ||
22 | * :ref:`modindex` | ||
23 | * :ref:`search` | ||
24 | |||
diff --git a/docs/using_tox.rst b/docs/using_tox.rst new file mode 100644 index 00000000..472d4ef4 --- /dev/null +++ b/docs/using_tox.rst | |||
@@ -0,0 +1,64 @@ | |||
1 | Using Tox | ||
2 | ========= | ||
3 | |||
4 | 1. Build Tox | ||
5 | 2. Fix errors | ||
6 | 3. Consult IRC for help | ||
7 | 4. Go on debugging journy for devs | ||
8 | 5. Build Tox for real | ||
9 | 6. ??? | ||
10 | |||
11 | For all the work we've put into Tox so far, there isn't yet a decent | ||
12 | guide for how you *use* Tox. Here's a user-friendly attempt at it. | ||
13 | |||
14 | 1. Connect to the network! | ||
15 | |||
16 | - You need to connect to a bootstrapping server, to give you a | ||
17 | public key. | ||
18 | - Where can I find a public server? Right here, as of now: (the help | ||
19 | message from running nTox with no args will help) | ||
20 | |||
21 | - 198.46.136.167 33445 | ||
22 | 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854 | ||
23 | - 192.81.133.111 33445 | ||
24 | 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858 | ||
25 | - 66.175.223.88 33445 | ||
26 | AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D | ||
27 | - 192.184.81.118 33445 | ||
28 | 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143 | ||
29 | |||
30 | 2. Find a friend! | ||
31 | |||
32 | - Now that you're on the network, you need a friend. To get one of | ||
33 | those, you need to to send or receive a request. What's a request, | ||
34 | you ask? It's like a friend request, but we use really scary and | ||
35 | cryptic numbers instead of names. When nTox starts, it shows your | ||
36 | *your* long, scary number, called your *public key*. Give that to | ||
37 | people, and they can add you as as "friend". Or, you can add | ||
38 | someone else, with the */f* command, if you like. | ||
39 | |||
40 | 3. Chat it up! | ||
41 | |||
42 | - Now use the */m* command to send a message to someone. Wow, you're | ||
43 | chatting! | ||
44 | |||
45 | 4. But something broke! | ||
46 | |||
47 | - Yeah, pre-alpha-alpha software tends to do that. We're working on | ||
48 | it. | ||
49 | - Please report all crashes to either the github page, or #tox-dev | ||
50 | on freenode. | ||
51 | |||
52 | 5. Nothing broke, but what does */f* mean? | ||
53 | |||
54 | - nTox parses text as a command if the first character is a | ||
55 | forward-slash ('/'). You can check all commands in commands.md. | ||
56 | |||
57 | 6. Use and support Tox! | ||
58 | |||
59 | - Code for us, debug for us, document for us, translate for us, even | ||
60 | just talk about us! | ||
61 | - The more interest we get, the more work gets done, the better Tox | ||
62 | is. | ||
63 | |||
64 | |||