[doc] errors during the sphinx doc generation

[picca]

Hello, I put here the errors reported during the build process with sphinx

make[1]: Entering directory '/<<PKGBUILDDIR>>'
PYBUILD_SYSTEM=custom \
PYBUILD_BUILD_ARGS="cd docs && PYTHONPATH={build_dir} http_proxy='127.0.0.1:9' {interpreter} -m sphinx -N -bhtml source build/html" dh_auto_build  # HTML generator
I: pybuild base:184: cd docs && PYTHONPATH=/<<PKGBUILDDIR>>/.pybuild/pythonX.Y_2.7/build http_proxy='127.0.0.1:9' python2.7 -m sphinx -N -bhtml source build/html
Running Sphinx v1.4.9
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 7 source files that are out of date
updating environment: 7 added, 0 changed, 0 removed
reading sources... [ 14%] building
reading sources... [ 28%] code
reading sources... [ 42%] gpyfft
reading sources... [ 57%] gpyfft_error
reading sources... [ 71%] includeme
reading sources... [ 85%] index
reading sources... [100%] plan

/<<PKGBUILDDIR>>/docs/source/gpyfft.rst:4: WARNING: missing attribute foo1 in object gpyfft.GpyFFT
/<<PKGBUILDDIR>>/docs/source/gpyfft.rst:4: WARNING: missing attribute fn_with_sphinxy_docstring in object gpyfft.GpyFFT
docstring of gpyfft.GpyFFT:9: ERROR: Unknown directive type "autosummary".

.. autosummary::
   :toctree:

   create_plan
   get_version
docstring of gpyfft.GpyFFT.create_plan:25: WARNING: Block quote ends without a blank line; unexpected unindent.
docstring of gpyfft.GpyFFT_Error:9: ERROR: Unknown directive type "autosummary".

.. autosummary::
   :toctree:

   args
   message
/<<PKGBUILDDIR>>/docs/source/includeme.rst:1: SEVERE: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '../README.rst'.
/<<PKGBUILDDIR>>/docs/source/plan.rst:4: WARNING: missing attribute get_dim in object gpyfft.Plan
docstring of gpyfft.Plan:28: ERROR: Unknown directive type "autosummary".

.. autosummary::
   :toctree:

   batch_size
   distances
   inplace
   layouts
   precision
   scale_backward
   scale_forward
   shape
   strides_in
   strides_out
   temp_array_size
   transpose_result
docstring of gpyfft.Plan:46: ERROR: Unknown directive type "autosummary".

.. autosummary::
   :toctree:

   bake
   enqueue_transform
   set_callback
docstring of gpyfft.Plan.__init__:28: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found

[geggo]

Am 28.09.2017 um 13:51 schrieb picca ***@***.***>: Hello, I put here the errors reported during the build process with sphinx

thanks for reporting. Sorry, docs are a mess, but at least there are some docs ... Pushed some attempts to fix the errors (but got in turn a lot more warnings). Please note, there is now a new dependency on recommonmark, see http://www.sphinx-doc.org/en/stable/markdown.html

…

make[1]: Entering directory '/<<PKGBUILDDIR>>' PYBUILD_SYSTEM=custom \ PYBUILD_BUILD_ARGS="cd docs && PYTHONPATH={build_dir} http_proxy='127.0.0.1:9' {interpreter} -m sphinx -N -bhtml source build/html" dh_auto_build # HTML generator I: pybuild base:184: cd docs && PYTHONPATH=/<<PKGBUILDDIR>>/.pybuild/pythonX.Y_2.7/build http_proxy='127.0.0.1:9' python2.7 -m sphinx -N -bhtml source build/html Running Sphinx v1.4.9 making output directory... loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [html]: targets for 7 source files that are out of date updating environment: 7 added, 0 changed, 0 removed reading sources... [ 14%] building reading sources... [ 28%] code reading sources... [ 42%] gpyfft reading sources... [ 57%] gpyfft_error reading sources... [ 71%] includeme reading sources... [ 85%] index reading sources... [100%] plan /<<PKGBUILDDIR>>/docs/source/gpyfft.rst:4: WARNING: missing attribute foo1 in object gpyfft.GpyFFT /<<PKGBUILDDIR>>/docs/source/gpyfft.rst:4: WARNING: missing attribute fn_with_sphinxy_docstring in object gpyfft.GpyFFT docstring of gpyfft.GpyFFT:9: ERROR: Unknown directive type "autosummary". .. autosummary:: :toctree: create_plan get_version docstring of gpyfft.GpyFFT.create_plan:25: WARNING: Block quote ends without a blank line; unexpected unindent. docstring of gpyfft.GpyFFT_Error:9: ERROR: Unknown directive type "autosummary". .. autosummary:: :toctree: args message /<<PKGBUILDDIR>>/docs/source/includeme.rst:1: SEVERE: Problems with "include" directive path: InputError: [Errno 2] No such file or directory: '../README.rst'. /<<PKGBUILDDIR>>/docs/source/plan.rst:4: WARNING: missing attribute get_dim in object gpyfft.Plan docstring of gpyfft.Plan:28: ERROR: Unknown directive type "autosummary". .. autosummary:: :toctree: batch_size distances inplace layouts precision scale_backward scale_forward shape strides_in strides_out temp_array_size transpose_result docstring of gpyfft.Plan:46: ERROR: Unknown directive type "autosummary". .. autosummary:: :toctree: bake enqueue_transform set_callback docstring of gpyfft.Plan.__init__:28: WARNING: Block quote ends without a blank line; unexpected unindent. looking for now-outdated files... none found — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#37>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA7Gs65kFPMBdrNF30Va_dwb5BLgFy5uks5sm4gngaJpZM4PnJQ7>.

[picca]

thanks for reporting. Sorry, docs are a mess, but at least there are some docs ...

no problem at all, it improves with time ;)

Pushed some attempts to fix the errors (but got in turn a lot more warnings). Please note, there is now a new dependency on recommonmark, see http://www.sphinx-doc.org/en/stable/markdown.html

Hopefully this is already packaged for Debian :)) picca@diffabs6:~/Debian$ apt-cache search recommonmark python-recommonmark - CommonMark utility for Docutils and Sphinx projects -- Python python-recommonmark-doc - CommonMark utility for Docutils and Sphinx projects -- doc python3-recommonmark - CommonMark utility for Docutils and Sphinx projects -- Python 3 recommonmark-scripts - CommonMark utility for Docutils and Sphinx projects -- scripts While you release a 0.8.0 version with these changes so I could upload into Debian ?