Package: waeup.sphinx.autodoc
|sources|issueswaeup.sphinx.autodocis aSphinxextension for autodocumenting
components/classes specific toZope3andGrok.This project is in early state. Use with care.Features available yet:When autodocumenting, ignore components with a dot in their
name. This can greatly reduce the number ofAttributeErrorsyou
get (and you cannot tackle otherwise) when usingSphinxwithGrokprojects.Newgrokindexesautodocumenter documentsgrok.Indexesdeclarations.ContentsInstallUsageignore_dot_named_membersgrokindexesDeveloper InstallRunning TestsLicenseInstallThis Python package can be installed viapip:$ pip install waeup.sphinx.autodocNormally you will installwaeup.sphinx.autodocwith yourZope3orGrokproject. It must be installed in a way, so thatSphinxcan find
the package. The way depends on your project. For most projects it
will be sufficient to addwaeup.sphinx.autodocin theinstall_requiresdict of yoursetup.py.UsageOnce installed, you can activate the package in theconf.pyof
your localSphinxsources:# conf.py
#
# ...
#
# 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',
    'waeup.sphinx.autodoc',
    # ...
]
#
# ...
#Please note, that you also have to activatesphinx.ext.autodoc,
which comes withSphinxautomatically.waeup.sphinx.autodocprovides a new config var and new directives.ignore_dot_named_membersThis config value can be set in theconf.pyof your project:# conf.py
# ...
ignore_dot_named_members = True
# ...Set to True by default. Avoids sphinx choking on member names with
dots in.If set toTrue, we skip all member that have a dot in name,
i.e. members likegrokcore.component.directive. Member names like
these are extensively used for instance bygrok.ForSphinxthis is a problem, as it assumes that dots in names
denote member objects of a parent object. Lots ofAttributeErrorsare the result.grokindexesThis directive renders agrok.Indexesinstance. Asgrok.Indexesis
normally an instance of some class and not a class, also anygrok.Indexes‘class’ will not be recognized as class by stockSphinx.Withwaeup.sphinx.autodocyou can describe agrok.Indexesinstance
in your code with the newgrokindexesdirective:.. grokindexes:: mymod.MyCatalog

     Description of MyCatalogAutoscanninggrok.Indexesinstances is also possible. For that you
can use theautogrokindexes:.. autogrokindexes:: mymod.MyCatalogOf course, in this casemymod.MyCatalogmust be importable duringSphinxrun.Developer InstallFor people that want to hack thewaeup.sphinx.autodocpackage
itself.Developers can fork a clone from github:$ git clone https://github.com/WAeUP/waeup.sphinx.autodoc.gitWe recommend to create and activate avirtualenvfirst:$ cd waeup.sphinx.autodoc
$ virtualenv -p /usr/bin/python2.7 py27
$ source py27/bin/activate
(py27) $We support Python versions 2.6, 2.7.Now you can create the devel environment:(py27) $ python setup.py devThis will fetch test packages (py.test) and other packages needed to
run tests. As we needgrokand other packages depending of lots of
other packages, unfortunately alotof packages will be downloaded
and installed.If download aborts, please keep calm and carry on by retrying.Running TestsAfter finishing this, you should be able to run tests:(py27) $ py.testIf you have different Python versions installed, you can usetoxfor
running tests against these:(py27) $ pip install tox  # only once
(py27) $ toxShould run tests in all officially supported Python versions.(py27) $ tox -e py26will run tests with a special Python version (here: Python 2.6).LicenseThis Python package is licensed under the GPL v3+.Copyright (C) 2015 Uli Fouquet and WAeUP Germany.