sphinx documentation, initial commit

docs/api/modules.rst

@@ -0,0 +1,10 @@
+osc
+===
+
+These are the packages in the osc package.
+
+.. toctree::
+   :maxdepth: 4
+
+   osc.core
+   osc.util

docs/api/osc.core.rst

@@ -0,0 +1,20 @@
+.. py:module:: osc.core
+
+core
+====
+
+This is the osc core module.
+
+basic structures
+----------------
+
+.. autoclass:: File
+    :members:
+
+
+.. autoclass:: Serviceinfo
+    :members:
+
+
+.. autoclass:: Linkinfo
+    :members:

docs/api/osc.util.rst

@@ -0,0 +1,78 @@
+osc.util package
+================
+
+Submodules
+----------
+
+osc.util.ar module
+------------------
+
+.. automodule:: osc.util.ar
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.archquery module
+-------------------------
+
+.. automodule:: osc.util.archquery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.cpio module
+--------------------
+
+.. automodule:: osc.util.cpio
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.debquery module
+------------------------
+
+.. automodule:: osc.util.debquery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.packagequery module
+----------------------------
+
+.. automodule:: osc.util.packagequery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.repodata module
+------------------------
+
+.. automodule:: osc.util.repodata
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.rpmquery module
+------------------------
+
+.. automodule:: osc.util.rpmquery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+osc.util.safewriter module
+--------------------------
+
+.. automodule:: osc.util.safewriter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: osc.util
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/tutorial.rst

@@ -0,0 +1,96 @@
+Tutorial
+========
+
+This is a tutorial on how to use the osc python api.
+
+Key to the |obs| are (remote):
+    
+    #. A **project**
+    #. A project has associated multiple **repositories** (linux distributions)
+    #. Multiple **packages** in a project will hold the builds against the difefrent **repositories**
+
+
+A user will deal with local checkout of a project in a **working copy**: this is similar to the 
+subversion checkout model.
+
+
+Initial config setup
+--------------------
+
+Osc the library requires an initial setup:
+
+    >>> import osc.conf
+    >>> osc.conf.get_config()
+
+This will read all the external config files (eg. ~/.oscrc) and the internal configuration 
+values.
+
+
+Acquiring the apiurl 
+--------------------
+
+All the osc operation will use a **apiurl** to lookup for things like passwords, username and other parameters
+while performing operations:
+
+    >>> apiurl = osc.conf.config['apiurl']
+
+
+Operations on a remote build server
+-----------------------------------
+
+osc is similar to subversion, it has a remote server and a local (checkout) **working** directory.
+First we'll go through the remote operation on a server **NOT** requiring a checkout.
+Operations are contained in the osc.core module:
+
+    >>> import osc.core
+
+
+List all the projects and packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This will show all the projects on the remote |obs|:
+
+    >>> for prj in osc.core.meta_get_project_list(apiurl, deleted=False):
+            print prj
+
+
+A project has **repositories** associated with it (eg. linux distributions):
+
+    >>> prj = 'home:cavallo71:opt-python-interpreters'
+    >>> for repo in osc.core.get_repos_of_project(apiurl, prj):
+            print repo
+
+
+A project contains packages and to list them all:
+    
+    >>> prj = 'home:cavallo71:opt-python-interpreters'
+    >>> for pkg in osc.core.meta_get_packagelist(apiurl, prj):
+            print pkg
+
+
+Add a package to an existing project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+Operations in a checked out **working copy**
+--------------------------------------------
+
+
+
+Create your first project: the hello project
+--------------------------------------------
+
+.. todo:: add he description on how to init a project
+
+
+Adding your firs package to the project hello: the world package
+----------------------------------------------------------------
+
+.. todo:: add he description on how to add a package
+
+
+
+Setting the build architectures
+-------------------------------
+
+

docs/conf.py

@@ -0,0 +1,298 @@
+# -*- coding: utf-8 -*-
+#
+# osc documentation build configuration file, created by
+# sphinx-quickstart on Sun Jan 24 13:06:29 2016.
+#
+# 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
+import os
+import shlex
+
+
+# top level dir (one above this file)
+topdir = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
+
+# 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, topdir)
+
+# -- 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.todo',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.ifconfig',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+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'osc'
+copyright = u'2016, see authors list'
+author = u'see authors list'
+
+# 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 = '1.2.3'
+# The full version, including alpha/beta/rc tags.
+release = '4.5.6'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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 = 'alabaster'
+
+# 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
+# "<project> v<release> 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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 <link> 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
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'oscdoc'
+
+# -- 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': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  (master_doc, 'osc.tex', u'osc Documentation',
+   u'see authors list', '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 = [
+    (master_doc, 'osc', u'osc Documentation',
+     [author], 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 = [
+  (master_doc, 'osc', u'osc Documentation',
+   author, 'osc', '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'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+rst_epilog = """
+.. |obs| replace:: open build service
+"""

docs/index.rst

@@ -0,0 +1,33 @@
+.. osc documentation master file, created by
+   sphinx-quickstart on Sun Jan 24 13:06:29 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to osc's documentation!
+===============================
+
+This is the documentation for the osc python client to the |obs|.
+
+Tutorial
+
+.. TODO:: add more documentation
+
+
+
+API:
+
+.. toctree::
+   :maxdepth: 2
+
+   api/tutorial
+   api/modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

setup.py

@@ -40,6 +40,30 @@ class build_osc(distutils.command.build.build, object):
         super(build_osc, self).run()
         self.build_man_page()
 
+
+# Support for documentation (sphinx)
+class build_docs(distutils.command.build.Command):
+    description = 'builds documentation using sphinx'
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        # metadata contains information supplied in setup()
+        metadata = self.distribution.metadata
+        # package_dir may be None, in that case use the current directory.
+        src_dir = (self.distribution.package_dir or {'': ''})['']
+        src_dir = os.path.join(os.getcwd(),  src_dir)
+        import sphinx
+        sphinx.main(['runme', 
+                    '-D', 'version=%s' % metadata.get_version(), 
+                    os.path.join('docs',), os.path.join('build', 'docs')])
+
+
 addparams = {}
 if HAVE_PY2EXE:
     addparams['console'] = [{'script': 'osc-wrapper.py', 'dest_base': 'osc', 'icon_resources': [(1, 'osc.ico')]}]
@@ -68,6 +92,7 @@ setup(name='osc',
       # Override certain command classes with our own ones
       cmdclass = {
         'build': build_osc,
+        'build_docs' : build_docs,
         },
       **addparams
      )