From: Salim Fadhley Date: Mon, 9 Jan 2012 17:01:39 +0000 (+0000) Subject: Switching back to Sphinx X-Git-Tag: v0.2.23~326 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1d5e351fb39bbc40d55316886abab0b67a24fd43;p=tools%2Fpython-jenkinsapi.git Switching back to Sphinx --- diff --git a/doc/build.properties b/doc/build.properties index 3781ee6..ff9e7b4 100644 --- a/doc/build.properties +++ b/doc/build.properties @@ -1,2 +1,3 @@ docs.zipfile.filename=docs_html.zip -docs.html.dir=html \ No newline at end of file +docs.html.dir=html +docs.source.dir=source \ No newline at end of file diff --git a/doc/build.xml b/doc/build.xml index c67a1dc..6d6cf68 100644 --- a/doc/build.xml +++ b/doc/build.xml @@ -7,15 +7,11 @@ - - - - - - - - - + + + + + diff --git a/doc/epydoc.cfg b/doc/epydoc.cfg deleted file mode 100644 index 3c67ef5..0000000 --- a/doc/epydoc.cfg +++ /dev/null @@ -1,19 +0,0 @@ -[epydoc] # Epydoc section marker (required by ConfigParser) - -# Information about the project. -name: JenkinsAPI -url: https://github.com/salimfadhley/jenkinsapi - -# The list of modules to document. Modules can be named using -# dotted names, module filenames, or package directory names. -# This option may be repeated. -modules: jenkinsapi - -# Write html output to the directory "apidocs" -output: html -target: doc/html/ - -# Include all automatically generated graphs. These graphs are -# generated using Graphviz dot. -#graph: all -#dotpath: /usr/local/bin/dot \ No newline at end of file diff --git a/doc/source/_static/tmp.txt b/doc/source/_static/tmp.txt new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/_templates/tmp.txt b/doc/source/_templates/tmp.txt new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..d4ce6e0 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,249 @@ +# -*- coding: utf-8 -*- +# +# JenkinsAPI documentation build configuration file, created by +# sphinx-quickstart on Mon Jan 09 16:35:17 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +DOC_SRC_DIR, _ = os.path.split( os.path.abspath( __file__ )) +DOC_DIR, _ = os.path.split( DOC_SRC_DIR ) +PROJECT_DIR, _ = os.path.split( DOC_DIR ) + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, PROJECT_DIR ) + +# Config file +import setup_config as jenkinsapi_setup_config + +# -- 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.doctest', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u' JenkinsAPI' +copyright = u'2012, %s' % jenkinsapi_setup_config.PROJECT_AUTHORS + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = jenkinsapi_setup_config.VERSION +# The full version, including alpha/beta/rc tags. +release = jenkinsapi_setup_config.REVISION + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# 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 = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'JenkinsAPIdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'JenkinsAPI.tex', u' JenkinsAPI Documentation', + u'xxx', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'jenkinsapi', u' JenkinsAPI Documentation', + [u'xxx'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'JenkinsAPI', u' JenkinsAPI Documentation', + u'xxx', 'JenkinsAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..66f59d9 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,22 @@ +.. JenkinsAPI documentation master file, created by + sphinx-quickstart on Mon Jan 09 16:35:17 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to JenkinsAPI's documentation! +======================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` +