diff --git a/.gitignore b/.gitignore index be512953..a46934a9 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,9 @@ _trial_temp/ build/ cpyamf/*.so doc/_build/ +doc/changelog.rst +doc/html/intro.html +doc/themes cpyamf/amf3.pyd cpyamf/codec.pyd -cpyamf/util.pyd \ No newline at end of file +cpyamf/util.pyd diff --git a/doc/Makefile b/doc/Makefile index 64fd6406..d09dd53b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -31,8 +31,8 @@ clean: -rm -rf $(BUILDDIR)/* html: - mkdir -p $(BUILDDIR)/html $(BUILDDIR)/doctrees - find tutorials/examples ! -name "*.svn*" | cpio -admup $(BUILDDIR)/html/ + mkdir -p $(BUILDDIR)/html/tutorials $(BUILDDIR)/doctrees + cp -R tutorials/examples $(BUILDDIR)/html/tutorials/ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/doc/conf.py b/doc/conf.py index 38f38ca2..52bb8761 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -23,11 +23,14 @@ # -- General configuration ----------------------------------------------------- +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = '1.0' + # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] -# Paths that contain templates, relative to this directory. +# Paths that contain additional templates, relative to this directory. templates_path = ['html'] # The suffix of source filenames. @@ -37,7 +40,7 @@ #source_encoding = 'utf-8' # The master toctree document. -#master_doc = 'index' +#master_doc = 'contents' # create content template for the homepage from util import rst2html, copy_file @@ -71,10 +74,9 @@ # List of documents that shouldn't be included in the build. #unused_docs = [] -# A list of directory paths, relative to the source directory, that are to -# be recursively excluded from the search for source files, that is, their -# subdirectories won’t be searched too. -exclude_trees = ['_build', 'tutorials/examples'] +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build', 'tutorials/examples'] # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -88,7 +90,7 @@ #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'trac' +#pygments_style = 'trac' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] @@ -96,10 +98,20 @@ # -- Options for HTML output --------------------------------------------------- -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -html_style = 'default.css' +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# Note: you can download the 'beam' theme from: +# http://github.com/collab-project/sphinx-themes +# and place it in a 'themes' directory relative to this config file. +html_theme = 'beam' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ['themes'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -111,7 +123,7 @@ html_static_path = ['html/static'] # The name of an image file (.ico) that is the favicon of the docs. -html_favicon = 'pyamf.ico' +html_favicon = 'html/static/pyamf.ico' # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -121,20 +133,15 @@ # typographically correct entities. #html_use_smartypants = True -# Custom sidebar templates, maps document names to template names. -html_sidebars = { - 'toc': 'sidebartoc.html' -} - # Additional templates that should be rendered to pages, maps page names to # template names. html_additional_pages = { - 'index': 'indexcontent.html', + 'index': 'defindex.html', 'tutorials/index': 'tutorials.html', } # Content template for the index page, filename relative to this file. -html_index = 'indexcontent.html' +#html_index = 'indexcontent.html' # If false, no module index is generated. html_use_modindex = True @@ -186,4 +193,4 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://python.org/': None} +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/html/indexcontent.html b/doc/html/defindex.html similarity index 98% rename from doc/html/indexcontent.html rename to doc/html/defindex.html index cb1a30ff..99945cde 100644 --- a/doc/html/indexcontent.html +++ b/doc/html/defindex.html @@ -1,4 +1,4 @@ -{% extends "defindex.html" %} +{% extends "basic/defindex.html" %} {% block body %}

{{ docstitle|e }}

diff --git a/doc/html/layout.html b/doc/html/layout.html index ffef1bc0..1c365742 100644 --- a/doc/html/layout.html +++ b/doc/html/layout.html @@ -1,30 +1,5 @@ -{% extends "!layout.html" %} -{% block document %} - -
- - - - -
-{{ super() }} -{% endblock %} -{% block relbar1 %} -{% endblock %} -{% block relbar2 %} +{% extends "beam/layout.html" %} -{% endblock %} {% block sidebartoc %}

Download

-{% endblock %} -{% block sidebarrel %} -{% endblock %} -{% block sidebarsourcelink %} -{% endblock %} -{% block sidebarsearch %} -{% endblock %} -{% block footer %} -
-{{ copyright }} -
-{% endblock %} -{% block rootrellink %} -{{ super() }} -{% endblock %} +{% endblock %} \ No newline at end of file diff --git a/doc/html/static/bg_gradient.jpg b/doc/html/static/bg_gradient.jpg deleted file mode 100644 index 019b49b8..00000000 Binary files a/doc/html/static/bg_gradient.jpg and /dev/null differ diff --git a/doc/html/static/default.css b/doc/html/static/default.css deleted file mode 100644 index 1dc96763..00000000 --- a/doc/html/static/default.css +++ /dev/null @@ -1,887 +0,0 @@ -body { - padding: 0; - background: url(bg_gradient.jpg) repeat-x; - font: 12px/18px "Lucida Grande", "Lucida Sans Unicode", Arial, Verdana, sans-serif; - background-color: #fff; - color: #333; -} - -/* Forms */ -input, textarea, select { margin: 2px } -input, select { vertical-align: middle } -input[type=button], input[type=submit], input[type=reset] { - background: #eee; - color: #222; - border: 1px outset #ccc; - padding: .1em .5em; -} - -input[type=button]:hover, input[type=submit]:hover, input[type=reset]:hover { - background: #ccb; -} - -input[type=button][disabled], input[type=submit][disabled], -input[type=reset][disabled] { - background: #f6f6f6; - border-style: solid; - color: #999; -} - -input[type=text], input.textwidget, textarea { border: 1px solid #d7d7d7 } -input[type=text], input.textwidget { - padding: .25em .5em; -} - -input[type=text]:focus, -input.textwidget:focus, -textarea:focus { - border: 1px solid #886; -} - -option { border-bottom: 1px dotted #d7d7d7 } -fieldset { border: 1px solid #d7d7d7; padding: .5em; margin: 1em 0 } -form p.hint, form span.hint { color: #666; font-size: 85%; margin: .5em 0; - padding-left: 1em; -} - -/* :::: LAYOUT :::: */ - -div.document { - padding: 10px 20px 0px 20px; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0px 0px 0px 170px; -} - -div.body { - background-color: white; - padding: 0 10px 10px 10px; -} - -div.sphinxsidebarwrapper { - padding: 0px 5px 0px 0px; -} - -div.sphinxsidebar { - float: left; - width: 170px; - margin-left: -100%; - font-size: 90%; -} - -div.clearer { - clear: both; -} - -div.footer { - clear: both; - color: #bbb; - font-size: 10px; - border-top: 1px solid; - height: 31px; - padding: .25em 0; - text-align: right; -} - -div.footer a { - color: #A0A0A0; - text-decoration: none; -} - -div.related { - color: #fff; - width: 100%; - height: 30px; - line-height: 30px; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -div.related a { - color: #204060; - font-weight: bold; -} - -/* ::: TOC :::: */ -div.sphinxsidebar h3 { - color: black; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h4 { - color: black; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: white; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - list-style: none; - color: white; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar a { - color: #08c; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - font-size: 1em; -} - -/* :::: MODULE CLOUD :::: */ -div.modulecloud { - margin: -5px 10px 5px 10px; - padding: 10px; - line-height: 160%; - border: 1px solid #cbe7e5; - background-color: #f2fbfd; -} - -div.modulecloud a { - padding: 0 5px 0 5px; -} - -/* :::: SEARCH :::: */ -ul.search { - margin: 0px 0 0 0px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* :::: COMMON FORM STYLES :::: */ - -div.actions { - padding: 5px 10px 5px 10px; - border-top: 1px solid #cbe7e5; - border-bottom: 1px solid #cbe7e5; - background-color: #e0f6f4; -} - -form dl { - color: #333; -} - -form dt { - clear: both; - float: left; - min-width: 110px; - margin-right: 10px; - padding-top: 2px; -} - -input#homepage { - display: none; -} - -div.error { - margin: 5px 20px 0 0; - padding: 5px; - border: 1px solid #d00; - font-weight: bold; -} - -/* :::: INLINE COMMENTS :::: */ - -div.inlinecomments { - position: absolute; - right: 20px; -} - -div.inlinecomments a.bubble { - display: block; - float: right; - background-image: url(style/comment.png); - background-repeat: no-repeat; - width: 25px; - height: 25px; - text-align: center; - padding-top: 3px; - font-size: 0.9em; - line-height: 14px; - font-weight: bold; - color: black; -} - -div.inlinecomments a.bubble span { - display: none; -} - -div.inlinecomments a.emptybubble { - background-image: url(style/nocomment.png); -} - -div.inlinecomments a.bubble:hover { - background-image: url(style/hovercomment.png); - text-decoration: none; - color: #3ca0a4; -} - -div.inlinecomments div.comments { - float: right; - margin: 25px 5px 0 0; - max-width: 50em; - min-width: 30em; - border: 1px solid #2eabb0; - background-color: #f2fbfd; - z-index: 150; -} - -div#comments { - border: 1px solid #2eabb0; - margin-top: 20px; -} - -div#comments div.nocomments { - padding: 10px; - font-weight: bold; -} - -div.inlinecomments div.comments h3, -div#comments h3 { - margin: 0; - padding: 0; - background-color: #2eabb0; - color: white; - border: none; - padding: 3px; -} - -div.inlinecomments div.comments div.actions { - padding: 4px; - margin: 0; - border-top: none; -} - -div#comments div.comment { - margin: 10px; - border: 1px solid #2eabb0; -} - -div.inlinecomments div.comment h4, -div.commentwindow div.comment h4, -div#comments div.comment h4 { - margin: 10px 0 0 0; - background-color: #2eabb0; - color: white; - border: none; - padding: 1px 4px 1px 4px; -} - -div#comments div.comment h4 { - margin: 0; -} - -div#comments div.comment h4 a { - color: #d5f4f4; -} - -div.inlinecomments div.comment div.text, -div.commentwindow div.comment div.text, -div#comments div.comment div.text { - margin: -5px 0 -5px 0; - padding: 0 10px 0 10px; -} - -div.inlinecomments div.comment div.meta, -div.commentwindow div.comment div.meta, -div#comments div.comment div.meta { - text-align: right; - padding: 2px 10px 2px 0; - font-size: 95%; - color: #538893; - border-top: 1px solid #cbe7e5; - background-color: #e0f6f4; -} - -div.commentwindow { - position: absolute; - width: 500px; - border: 1px solid #cbe7e5; - background-color: #f2fbfd; - display: none; - z-index: 130; -} - -div.commentwindow h3 { - margin: 0; - background-color: #2eabb0; - color: white; - border: none; - padding: 5px; - font-size: 1.5em; - cursor: pointer; -} - -div.commentwindow div.actions { - margin: 10px -10px 0 -10px; - padding: 4px 10px 4px 10px; - color: #538893; -} - -div.commentwindow div.actions input { - border: 1px solid #2eabb0; - background-color: white; - color: #135355; - cursor: pointer; -} - -div.commentwindow div.form { - padding: 0 10px 0 10px; -} - -div.commentwindow div.form input, -div.commentwindow div.form textarea { - border: 1px solid #3c9ea2; - background-color: white; - color: black; -} - -div.commentwindow div.error { - margin: 10px 5px 10px 5px; - background-color: #fbe5dc; - display: none; -} - -div.commentwindow div.form textarea { - width: 99%; -} - -div.commentwindow div.preview { - margin: 10px 0 10px 0; - background-color: #70d0d4; - padding: 0 1px 1px 25px; -} - -div.commentwindow div.preview h4 { - margin: 0 0 -5px -20px; - padding: 4px 0 0 4px; - color: white; - font-size: 1.3em; -} - -div.commentwindow div.preview div.comment { - background-color: #f2fbfd; -} - -div.commentwindow div.preview div.comment h4 { - margin: 10px 0 0 0!important; - padding: 1px 4px 1px 4px!important; - font-size: 1.2em; -} - -/* :::: SUGGEST CHANGES :::: */ -div#suggest-changes-box input, div#suggest-changes-box textarea { - border: 1px solid #ccc; - background-color: white; - color: black; -} - -div#suggest-changes-box textarea { - width: 99%; - height: 400px; -} - - -/* :::: PREVIEW :::: */ -div.preview { - background-image: url(style/preview.png); - padding: 0 20px 20px 20px; - margin-bottom: 30px; -} - - -/* :::: INDEX PAGE :::: */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - - font-size: 90%; -} - -/* :::: INDEX STYLES :::: */ - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -form.pfform { - margin: 10px 0 20px 0; -} - -/* :::: GLOBAL STYLES :::: */ - -.docwarning { - background-color: #ffe4e4; - padding: 10px; - margin: 0 -20px 0 -20px; - border-bottom: 1px solid #f66; -} - -p.subhead { - font-weight: bold; - margin-top: 20px; -} - -a { - color: #08c; - text-decoration: none; -} - -a:hover { - text-decoration: none; -} - -a.toplogo -{ - background: transparent; - text-decoration: none; - border: none; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { - font-size: 24px; - line-height: 36px; - margin-bottom: 18px; -} - -div.body h2 { - font-size: 16px; - line-height: 18px; - margin-bottom: 18px; -} - -div.body h3 { - font-size: 1em; - line-height: 18px; -} - -div.body h4 { - font-size: 12px; - line-height: 18px; -} - -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #bbb; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -a.headerlink:hover { - background-color: #585858; - color: white; -} - -div.body p, div.body dd, div.body li { - /*text-align: justify;*/ - line-height: 130%; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -ul.fakelist { - list-style: none; - margin: 10px 0 10px 20px; - padding: 0; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -/* "Footnotes" heading */ -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -/* "Topics" */ - -div.topic { - background-color: #F8F8F8; - border: 1px solid #ccc; - padding: 10px 10px 10px 10px; - margin: 10px 10px 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* Admonitions */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -div.admonition p { - display: inline; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -table.docutils { - border: 0; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 0; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -dl { - margin-bottom: 15px; - clear: both; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -.refcount { - color: #060; -} - -dt:target, -.highlight { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -th { - text-align: left; - padding-right: 5px; -} - -pre { - padding: 5px; - background-color: #FAFAFA; - color: #333; - border: 1px solid #999999; - border-left: none; - border-right: none; - overflow: auto; -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -.footnote:target { background-color: #ffa } - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -form.comment { - margin: 0; - padding: 10px 30px 10px 30px; - background-color: #eee; -} - -form.comment h3 { - background-color: #326591; - color: white; - margin: -10px -30px 10px -30px; - padding: 5px; - font-size: 1.4em; -} - -form.comment input, -form.comment textarea { - border: 1px solid #ccc; - padding: 2px; - font-family: sans-serif; - font-size: 100%; -} - -form.comment input[type="text"] { - width: 240px; -} - -form.comment textarea { - width: 100%; - height: 200px; - margin-bottom: 10px; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -/* :::: PRINT :::: */ -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0; - width : 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - div#comments div.new-comment-box, - #top-link { - display: none; - } -} diff --git a/setup.py b/setup.py index 1cfbe8e5..be595a0f 100644 --- a/setup.py +++ b/setup.py @@ -185,7 +185,6 @@ def main(): "Operating System :: OS Independent", "Programming Language :: C", "Programming Language :: Python", - "Programming Language :: Python :: 2.3", "Programming Language :: Python :: 2.4", "Programming Language :: Python :: 2.5", "Programming Language :: Python :: 2.6",