[yoda-svn] yoda: 2 new changesets

YODA Mercurial yoda at projects.hepforge.org
Thu Mar 31 14:15:01 BST 2016


details:   https://yoda.hepforge.org/hg/yoda/rev/b821f66080cd
branches:  release-1-5
changeset: 1228:b821f66080cd
user:      Andy Buckley <andy at insectnation.org>
date:      Thu Mar 31 14:00:33 2016 +0100
description:
Adding basic usage examples to the Sphinx docs

details:   https://yoda.hepforge.org/hg/yoda/rev/c985b0601351
branches:  release-1-5
changeset: 1229:c985b0601351
user:      Andy Buckley <andy at insectnation.org>
date:      Thu Mar 31 14:02:46 2016 +0100
description:
Conf file update for YODA version and date

diffs (truncated from 152 to 50 lines):

--- a/pydoc/conf.py	Wed Mar 09 17:47:10 2016 +0000
+++ b/pydoc/conf.py	Thu Mar 31 14:02:46 2016 +0100
@@ -50,16 +50,16 @@
 
 # General information about the project.
 project = u'YODA'
-copyright = u'2015, YODA Collaboration'
+copyright = u'2010-2016, YODA Collaboration'
 
 # 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.3.1'
+version = '1.5.9'
 # The full version, including alpha/beta/rc tags.
-release = '1.3.1'
+release = '1.5.9'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
--- a/pydoc/index.rst	Wed Mar 09 17:47:10 2016 +0000
+++ b/pydoc/index.rst	Thu Mar 31 14:02:46 2016 +0100
@@ -1,8 +1,3 @@
-.. YODA documentation master file, created by
-   sphinx-quickstart on Wed Oct 29 21:06:27 2014.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to YODA's documentation!
 ================================
 
@@ -57,16 +52,92 @@
    :maxdepth: 2
 
 
-Main YODA objects
------------------
+Basic usage
+-----------
 
-The wrappers on the core C++ YODA data types and functions are all defined in
-the `yoda.core` module, which is generated semi-automatically by the Cython
-system. However, they are all available directly in the `yoda` namespace by
-virtue of a `from yoda.core import *` in the `yoda` package.
+- Booking and filling a histogram called '/foo' with 20 bins between 0 and 1: ::
 
-.. automodule:: yoda.core
-   :members:


More information about the yoda-svn mailing list