diff --git a/README.rst b/README.rst index 9b4d5102a377a57a7a1e2dd0404b9c62de897bf7..e9606d0809ba7c73ff69b52320bc9a5144bea250 100644 --- a/README.rst +++ b/README.rst @@ -2,12 +2,16 @@ .. Andre Anjos <andre.anjos@idiap.ch> .. Thu 30 Jan 08:46:53 2014 CET +.. image:: http://img.shields.io/badge/docs-stable-yellow.png + :target: http://pythonhosted.org/bob.buildout/index.html +.. image:: http://img.shields.io/badge/docs-latest-orange.png + :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.buildout/master/index.html .. image:: https://travis-ci.org/bioidiap/bob.buildout.svg?branch=master :target: https://travis-ci.org/bioidiap/bob.buildout .. image:: https://coveralls.io/repos/bioidiap/bob.buildout/badge.png :target: https://coveralls.io/r/bioidiap/bob.buildout -.. image:: http://img.shields.io/github/tag/bioidiap/bob.buildout.png - :target: https://github.com/bioidiap/bob.buildout +.. image:: https://img.shields.io/badge/github-master-0000c0.png + :target: https://github.com/bioidiap/bob.buildout/tree/master .. image:: http://img.shields.io/pypi/v/bob.buildout.png :target: https://pypi.python.org/pypi/bob.buildout .. image:: http://img.shields.io/pypi/dm/bob.buildout.png diff --git a/bob/buildout/scripts.py b/bob/buildout/scripts.py index b56e1163da576664c32e56d12c0033485982989f..685ac3dfcbef7b010672abd31d2bf025bb4ea8a4 100644 --- a/bob/buildout/scripts.py +++ b/bob/buildout/scripts.py @@ -196,8 +196,7 @@ class Sphinx(Script): self.options['dependent-scripts'] = 'false' eggs = tools.eggs(self.buildout['buildout'], self.options, self.name) - self.options['eggs'] = tools.add_eggs(eggs, - ['sphinx', 'sphinx-pypi-upload']) + self.options['eggs'] = tools.add_eggs(eggs, ['sphinx']) # initializes base class super(Sphinx, self).__init__(self.buildout, self.name, self.options) diff --git a/buildout.cfg b/buildout.cfg index 6b75c7e9302684b0af30ad6a9fb9cac980ddcf81..a34f8efc186c0e4451fd0b8e2e8113bf8a5f7435 100644 --- a/buildout.cfg +++ b/buildout.cfg @@ -7,5 +7,7 @@ parts = scripts develop = . eggs = bob.buildout +newest = false + [scripts] recipe = bob.buildout:scripts diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..4178f2d67e67a93b53d3b53d32f7641daa5606bf --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,259 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Tue 15 Oct 16:37:18 2013 CEST +# +# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland + +import os +import sys +import glob +import pkg_resources + +# 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, os.path.abspath('.')) + +# -- 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.coverage', + 'sphinx.ext.pngmath', + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + ] + +# The viewcode extension appeared only on Sphinx >= 1.0.0 +import sphinx +if sphinx.__version__ >= "1.0": + extensions.append('sphinx.ext.viewcode') + +# Always includes todos +todo_include_todos = True + +# If we are on OSX, the 'dvipng' path maybe different +dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng' +if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx + +# 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'bob.buildout' +import time +copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') + +# Grab the setup entry +### Unfortunately, this doesn't work for bob.buildout +#distribution = pkg_resources.require('bob.buildout')[0] + +# 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 = "2.0.0a0" +# The full version, including alpha/beta/rc tags. +release = version + +# 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 = ['links.rst'] + +# 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. +if sphinx.__version__ >= "1.0": + html_theme = 'nature' + +# 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 = 'bob_extension' + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = 'img/logo.png' + +# 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 = 'img/favicon.ico' + +# 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 <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 + +# Output file base name for HTML help builder. +htmlhelp_basename = 'bob_buildout_doc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +latex_paper_size = 'a4' + +# The font size ('10pt', '11pt' or '12pt'). +latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'bob_extension.tex', u'Bob Buildout Rules', + u'Biometrics Group, Idiap Research Institute', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = '' + +# 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 + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# Included after all input documents +rst_epilog = """ +.. |project| replace:: Bob +.. |url| replace:: https://www.idiap.ch/software/bob/ +.. |version| replace:: %s +.. |current-year| date:: %%Y +""" % (version,) + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'bob_extension', u'Bob Buildout Rules Documentation', [u'Idiap Research Institute'], 1) +] + +# Default processing flags for sphinx +autoclass_content = 'both' +autodoc_member_order = 'bysource' +autodoc_default_flags = [ + 'members', + 'undoc-members', + 'inherited-members', + 'show-inheritance', + ] + +def setup(app): + pass diff --git a/doc/img/favicon.ico b/doc/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..4cc3264302627d40868261add69eb755856611b6 Binary files /dev/null and b/doc/img/favicon.ico differ diff --git a/doc/img/logo.png b/doc/img/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..b9dd573a01019afd1af58a881996930e5212699d Binary files /dev/null and b/doc/img/logo.png differ diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..9a324594b4a062902838b5ac5803085e775b2d4e --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,31 @@ +.. vim: set fileencoding=utf-8 : +.. Andre Anjos <andre.anjos@idiap.ch> +.. Mon 17 Mar 09:23:45 2014 CET +.. +.. Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland + +==================== + Bob Buildout Rules +==================== + +.. todolist:: + + +.. todo:: Write documentation of this package + + +Documentation +------------- + +.. toctree:: + :maxdepth: 2 + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +.. include:: links.rst diff --git a/doc/links.rst b/doc/links.rst new file mode 100644 index 0000000000000000000000000000000000000000..4884a0e927c6a2a088d808a2f344f75d628be256 --- /dev/null +++ b/doc/links.rst @@ -0,0 +1,23 @@ +.. vim: set fileencoding=utf-8 : +.. Andre Anjos <andre.anjos@idiap.ch> +.. Tue 20 Mar 2012 08:57:32 CET +.. +.. Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland + +.. _bob's website: https://www.idiap.ch/software/bob +.. _bob: https://www.idiap.ch/software/bob +.. _c++: http://www2.research.att.com/~bs/C++.html +.. _distutils: http://docs.python.org/distutils/ +.. _git: http://git-scm.com/ +.. _github: http://github.com/ +.. _idiap: http://www.idiap.ch +.. _ipython: http://ipython.scipy.org +.. _nose: https://nose.readthedocs.org/en/latest/ +.. _pep 386: http://www.python.org/dev/peps/pep-0386/ +.. _python: http://www.python.org +.. _pypi: http://pypi.python.org +.. _satellite packages: https://github.com/idiap/bob/wiki/Satellite-Packages +.. _setuptools: http://trac.edgewall.org/wiki/setuptools +.. _sphinx: http://sphinx.pocoo.org +.. _zc.buildout: http://pypi.python.org/pypi/zc.buildout/ + diff --git a/setup.py b/setup.py index 6e862f8d3794128c59bdffbb58ad7aed0cd6508a..a99b7728d0361f74e7698322983230e7209698d0 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ from setuptools import setup, find_packages setup( name='bob.buildout', - version='0.5.0a0', + version='2.0.0a0', description="zc.buildout recipes to perform a variety of tasks required by Bob satellite packages", keywords=['buildout', 'sphinx', 'nose', 'recipe', 'eggs', 'bob'], url='http://github.com/bioidiap/bob.buildout', @@ -51,6 +51,7 @@ setup( ], classifiers=[ + 'Framework :: Bob', 'Development Status :: 4 - Beta', 'Environment :: Plugins', 'Framework :: Buildout :: Recipe',