Commit 81753eaf authored by Manuel Günther's avatar Manuel Günther

Made documentation more beautiful using the novel xbob.extension/documentation.h

parent 8216e504
......@@ -21,6 +21,7 @@ prefixes = /idiap/group/torch5spro/nightlies/last/bob/linux-x86_64-release
[sources]
xbob.extension = git https://github.com/bioidiap/xbob.extension branch=prototype
xbob.blitz = git https://github.com/bioidiap/xbob.blitz
numpydoc = git git@github.com:numpy/numpydoc.git
[scripts]
recipe = xbob.buildout:scripts
......@@ -31,8 +31,14 @@ extensions = [
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'numpydoc',
]
# See: https://github.com/phn/pytpm/issues/3
numpydoc_show_class_members = False
# See... figured out myself :-(
numpydoc_class_members_toctree = False
# The viewcode extension appeared only on Sphinx >= 1.0.0
import sphinx
if sphinx.__version__ >= "1.0":
......@@ -143,7 +149,7 @@ html_favicon = ''
# 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']
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
......@@ -250,6 +256,7 @@ autodoc_member_order = 'bysource'
autodoc_default_flags = [
'members',
'undoc-members',
'private-members',
'inherited-members',
'show-inheritance',
]
......
......@@ -28,4 +28,9 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`
To-Do list
----------
.. todolist::
.. include:: links.rst
......@@ -8,5 +8,17 @@
This section includes information for using the pure Python API of ``xbob.math``.
Summary
.......
.. autosummary::
xbob.math.LPInteriorPoint
xbob.math.LPInteriorPointShortstep
xbob.math.LPInteriorPointLongstep
Details
.......
.. automodule:: xbob.math
:members:
......@@ -4,8 +4,9 @@
# Mon 16 Apr 08:18:08 2012 CEST
from setuptools import setup, find_packages, dist
dist.Distribution(dict(setup_requires=['xbob.blitz']))
dist.Distribution(dict(setup_requires=['xbob.blitz','xbob.extension']))
from xbob.blitz.extension import Extension
import xbob.extension
import os
package_dir = os.path.dirname(os.path.realpath(__file__))
......@@ -33,6 +34,8 @@ setup(
install_requires=[
'setuptools',
'xbob.blitz',
'xbob.extension',
'numpydoc',
],
namespace_packages=[
......@@ -61,8 +64,9 @@ setup(
packages = packages,
version = version,
include_dirs = include_dirs,
),
],
# define_macros = [('XBOB_SHORT_DOCSTRINGS',1)],
),
],
entry_points={
},
......
from ._library import __version__
from ._library import *
# To get the full API documentation automatically
__all__ = dir()
def get_config():
"""Returns a string containing the configuration information.
"""
......@@ -21,4 +25,4 @@ def get_config():
return retval.strip()
# gets sphinx autodoc done right - don't remove it
__all__ = [_ for _ in dir() if not _.startswith('_')]
__all__ = [_ for _ in dir() if not _.startswith('_')]
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment