Skip to content

Commit 16362b7

Browse files
committed
prep 0.9 of txeffect
1 parent b7d05e7 commit 16362b7

File tree

3 files changed

+5
-263
lines changed

3 files changed

+5
-263
lines changed

docs/source/conf.py

Lines changed: 3 additions & 257 deletions
Original file line numberDiff line numberDiff line change
@@ -1,269 +1,15 @@
11
# -*- coding: utf-8 -*-
2-
#
3-
# Effect documentation build configuration file, created by
4-
# sphinx-quickstart on Mon Dec 22 12:01:30 2014.
5-
#
6-
# This file is execfile()d with the current directory set to its
7-
# containing dir.
8-
#
9-
# Note that not all possible configuration values are present in this
10-
# autogenerated file.
11-
#
12-
# All configuration values have a default; values that are commented out
13-
# serve to show the default.
142

15-
import sys
16-
import os
17-
18-
import alabaster # radix
19-
20-
# If extensions (or modules to document with autodoc) are in another directory,
21-
# add these directories to sys.path here. If the directory is relative to the
22-
# documentation root, use os.path.abspath to make it absolute, like shown here.
23-
#sys.path.insert(0, os.path.abspath('.'))
24-
25-
# -- General configuration ------------------------------------------------
26-
27-
# If your documentation needs a minimal Sphinx version, state it here.
28-
#needs_sphinx = '1.0'
29-
30-
# Add any Sphinx extension module names here, as strings. They can be
31-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32-
# ones.
333
extensions = [
344
'sphinx.ext.autodoc',
355
'sphinx.ext.viewcode',
36-
'alabaster', # radix
376
]
387

39-
# RADIX CUSTOMIZATION
8+
# include __init__ docstrings in class docstrings
409
autoclass_content = 'both'
4110

42-
# Add any paths that contain templates here, relative to this directory.
43-
templates_path = ['_templates']
44-
45-
# The suffix of source filenames.
4611
source_suffix = '.rst'
47-
48-
# The encoding of source files.
49-
#source_encoding = 'utf-8-sig'
50-
51-
# The master toctree document.
5212
master_doc = 'index'
53-
54-
# General information about the project.
55-
project = u'Effect'
13+
project = u'txEffect'
5614
copyright = u'2015, Christopher Armstrong'
57-
58-
# The version info for the project you're documenting, acts as replacement for
59-
# |version| and |release|, also used in various other places throughout the
60-
# built documents.
61-
#
62-
# The short X.Y version.
63-
version = '0.1a2'
64-
# The full version, including alpha/beta/rc tags.
65-
release = '0.1a2'
66-
67-
# The language for content autogenerated by Sphinx. Refer to documentation
68-
# for a list of supported languages.
69-
#language = None
70-
71-
# There are two options for replacing |today|: either, you set today to some
72-
# non-false value, then it is used:
73-
#today = ''
74-
# Else, today_fmt is used as the format for a strftime call.
75-
#today_fmt = '%B %d, %Y'
76-
77-
# List of patterns, relative to source directory, that match files and
78-
# directories to ignore when looking for source files.
79-
exclude_patterns = []
80-
81-
# The reST default role (used for this markup: `text`) to use for all
82-
# documents.
83-
#default_role = None
84-
85-
# If true, '()' will be appended to :func: etc. cross-reference text.
86-
#add_function_parentheses = True
87-
88-
# If true, the current module name will be prepended to all description
89-
# unit titles (such as .. function::).
90-
#add_module_names = True
91-
92-
# If true, sectionauthor and moduleauthor directives will be shown in the
93-
# output. They are ignored by default.
94-
#show_authors = False
95-
96-
# The name of the Pygments (syntax highlighting) style to use.
97-
pygments_style = 'sphinx'
98-
99-
# A list of ignored prefixes for module index sorting.
100-
#modindex_common_prefix = []
101-
102-
# If true, keep warnings as "system message" paragraphs in the built documents.
103-
#keep_warnings = False
104-
105-
106-
# -- Options for HTML output ----------------------------------------------
107-
108-
# The theme to use for HTML and HTML Help pages. See the documentation for
109-
# a list of builtin themes.
110-
html_theme = 'alabaster'
111-
112-
# Theme options are theme-specific and customize the look and feel of a theme
113-
# further. For a list of options available for each theme, see the
114-
# documentation.
115-
#html_theme_options = {}
116-
117-
# Add any paths that contain custom themes here, relative to this directory.
118-
html_theme_path = [alabaster.get_path()] # radix
119-
120-
# The name for this set of Sphinx documents. If None, it defaults to
121-
# "<project> v<release> documentation".
122-
#html_title = None
123-
124-
# A shorter title for the navigation bar. Default is the same as html_title.
125-
#html_short_title = None
126-
127-
# The name of an image file (relative to this directory) to place at the top
128-
# of the sidebar.
129-
#html_logo = None
130-
131-
# The name of an image file (within the static path) to use as favicon of the
132-
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
133-
# pixels large.
134-
#html_favicon = None
135-
136-
# Add any paths that contain custom static files (such as style sheets) here,
137-
# relative to this directory. They are copied after the builtin static files,
138-
# so a file named "default.css" will overwrite the builtin "default.css".
139-
# html_static_path = ['_static']
140-
141-
# Add any extra paths that contain custom files (such as robots.txt or
142-
# .htaccess) here, relative to this directory. These files are copied
143-
# directly to the root of the documentation.
144-
#html_extra_path = []
145-
146-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147-
# using the given strftime format.
148-
#html_last_updated_fmt = '%b %d, %Y'
149-
150-
# If true, SmartyPants will be used to convert quotes and dashes to
151-
# typographically correct entities.
152-
#html_use_smartypants = True
153-
154-
# Custom sidebar templates, maps document names to template names.
155-
html_sidebars = { # radix
156-
'**': ['about.html', 'navigation.html', 'searchbox.html', 'donate.html'],
157-
}
158-
159-
# Additional templates that should be rendered to pages, maps page names to
160-
# template names.
161-
#html_additional_pages = {}
162-
163-
# If false, no module index is generated.
164-
#html_domain_indices = True
165-
166-
# If false, no index is generated.
167-
#html_use_index = True
168-
169-
# If true, the index is split into individual pages for each letter.
170-
#html_split_index = False
171-
172-
# If true, links to the reST sources are added to the pages.
173-
#html_show_sourcelink = True
174-
175-
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
176-
#html_show_sphinx = True
177-
178-
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
179-
#html_show_copyright = True
180-
181-
# If true, an OpenSearch description file will be output, and all pages will
182-
# contain a <link> tag referring to it. The value of this option must be the
183-
# base URL from which the finished HTML is served.
184-
#html_use_opensearch = ''
185-
186-
# This is the file name suffix for HTML files (e.g. ".xhtml").
187-
#html_file_suffix = None
188-
189-
# Output file base name for HTML help builder.
190-
htmlhelp_basename = 'Effectdoc'
191-
192-
193-
# -- Options for LaTeX output ---------------------------------------------
194-
195-
latex_elements = {
196-
# The paper size ('letterpaper' or 'a4paper').
197-
#'papersize': 'letterpaper',
198-
199-
# The font size ('10pt', '11pt' or '12pt').
200-
#'pointsize': '10pt',
201-
202-
# Additional stuff for the LaTeX preamble.
203-
#'preamble': '',
204-
}
205-
206-
# Grouping the document tree into LaTeX files. List of tuples
207-
# (source start file, target name, title,
208-
# author, documentclass [howto, manual, or own class]).
209-
latex_documents = [
210-
('index', 'Effect.tex', u'Effect Documentation',
211-
u'Christopher Armstrong', 'manual'),
212-
]
213-
214-
# The name of an image file (relative to this directory) to place at the top of
215-
# the title page.
216-
#latex_logo = None
217-
218-
# For "manual" documents, if this is true, then toplevel headings are parts,
219-
# not chapters.
220-
#latex_use_parts = False
221-
222-
# If true, show page references after internal links.
223-
#latex_show_pagerefs = False
224-
225-
# If true, show URL addresses after external links.
226-
#latex_show_urls = False
227-
228-
# Documents to append as an appendix to all manuals.
229-
#latex_appendices = []
230-
231-
# If false, no module index is generated.
232-
#latex_domain_indices = True
233-
234-
235-
# -- Options for manual page output ---------------------------------------
236-
237-
# One entry per manual page. List of tuples
238-
# (source start file, name, description, authors, manual section).
239-
man_pages = [
240-
('index', 'effect', u'Effect Documentation',
241-
[u'Christopher Armstrong'], 1)
242-
]
243-
244-
# If true, show URL addresses after external links.
245-
#man_show_urls = False
246-
247-
248-
# -- Options for Texinfo output -------------------------------------------
249-
250-
# Grouping the document tree into Texinfo files. List of tuples
251-
# (source start file, target name, title, author,
252-
# dir menu entry, description, category)
253-
texinfo_documents = [
254-
('index', 'Effect', u'Effect Documentation',
255-
u'Christopher Armstrong', 'Effect', 'One line description of project.',
256-
'Miscellaneous'),
257-
]
258-
259-
# Documents to append as an appendix to all manuals.
260-
#texinfo_appendices = []
261-
262-
# If false, no module index is generated.
263-
#texinfo_domain_indices = True
264-
265-
# How to display URL addresses: 'footnote', 'no', or 'inline'.
266-
#texinfo_show_urls = 'footnote'
267-
268-
# If true, do not generate a @detailmenu in the "Top" node's menu.
269-
#texinfo_no_detailmenu = False
15+
version = release = '0.9'

rtd-requirements.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

setup.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@
33

44
setuptools.setup(
55
name="txeffect",
6-
version="0.1a2",
6+
version="0.9",
77
description="Effect/Twisted integration",
88
long_description=open('README.rst').read(),
9-
url="http://github.com/python-effect/txeffect/",
9+
url="https://github.com/python-effect/txeffect/",
1010
author="Christopher Armstrong",
1111
license="MIT",
1212
classifiers=[
13-
'Development Status :: 3 - Alpha',
1413
'License :: OSI Approved :: MIT License',
1514
'Programming Language :: Python :: 2',
1615
'Programming Language :: Python :: 3',

0 commit comments

Comments
 (0)