#73 [taurus] sphinx documentation issue

open
nobody
taurus (5)
Taurus
5
2013-07-09
2012-01-28
No

Hello,

I am playing with the taurus packaging.
on debian machine the package is built for each available python version (2.6 and 2.7)
and when it will be ready for the 3.x series.
so to optimize a bit the build time (Debian managed on it buildd machines 35000+ packages...)
I tryed to build the documentation only once with the standard sphinx-build command.

It seems that it works but in fact the api is not generated and there is also a few ERRORS etc...

do you think that it would be possible to build all the taurus documentation with the standard sphinx command.

thanks

Frederic

picca@xxxxx:~/Debian/taurus/taurus$ sphinx-build doc/source/ /tmp/html/
Making output directory...
Running Sphinx v1.0.8
loading pickled environment... not yet created
No builder selected, using default: html
loading intersphinx inventory from http://www.tango-controls.org/static/PyTango/latest/doc/html/objects.inv...
loading intersphinx inventory from http://docs.python.org/dev/objects.inv...
loading intersphinx inventory from http://docs.scipy.org/doc/scipy/reference/objects.inv...
loading intersphinx inventory from http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/objects.inv...
loading intersphinx inventory from http://docs.scipy.org/doc/numpy/objects.inv...
building [html]: targets for 31 source files that are out of date
updating environment: 31 added, 0 changed, 0 removed
reading sources... [100%] users/ui/ui_colors
/home/picca/Debian/taurus/taurus/doc/source/devel/icon_guide.rst:34: SEVERE: Problems with "raw" directive path:
IOError: [Errno 2] No such file or directory: u'doc/source/devel/catalog.html'.
/home/picca/Debian/taurus/taurus/doc/source/devel/index.rst:7: WARNING: toctree contains reference to nonexisting document u'devel/api/taurus'
/home/picca/Debian/taurus/taurus/doc/source/devel/index.rst:7: WARNING: toctree contains reference to nonexisting document u'devel/api/taurus_AllClasses'
/home/picca/Debian/taurus/taurus/doc/source/users/ui/taurusgui.rst:139: ERROR: Error in "tip" directive:
invalid option block.

.. tip:: If, for some reason, you changed the panels too much and would like to
revert the changes, you can always load a previously saved
:ref:`perspective <perspectives>`.
/home/picca/Debian/taurus/taurus/doc/source/users/ui/taurusimage.rst:29: ERROR: Error in "note" directive:
invalid option block.

.. note:: The :class:`TaurusImageDialog` widget is provided by the
:mod:`taurus.qt.qtgui.extra_guiqwt` module which depends on the
:mod:`guiqwt` module being installed. If guiqwt is not installed,
the image widget will not be available.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] users/ui/ui_colors
writing additional files... (0 module code pages) genindex search
copying images... [100%] _static/taurustrend02.png
copying downloadable files... [100%] devel/examples/TaurusTest.py
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 5 warnings.

Discussion

  • Frédéric PICCA

    Sorry I should have put it in feature request

     
  • Carlos Pascual

    Carlos Pascual - 2012-01-30

    Regarding the API:
    For now, lots of .rst files need to be generated before the sphinx command is called. This is done by calling the taurus/doc/auto_rst4api script.

    This is needed because, when we first created the docs, sphinx was not able to autogenerate the desired help structure. I am not sure if now it could be solved in a more standard way using the latest sphinx features, but this is IMHO a low priority thing.

     
  • Carlos Pascual

    Carlos Pascual - 2013-03-12
    • assigned_to: tiagocoutinho --> nobody
    • labels: 2096169 --> taurus
     
  • Emmanuel Taurel

    Emmanuel Taurel - 2013-07-09
    • Category: --> Taurus