documentation cannot be built by sphinx

[Andre Massing]

I tried either of these commands
make html
make dirhtml
make singlehtml
and could not build it because of the following error (from the error.log) :
# Sphinx version: 1.0.7
# Python version: 2.7.0
# Docutils version: 0.7 release
# Jinja2 version: 2.5.5
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/sphinx/cmdline.py", line 188, in main
    app.build(force_all, filenames)
  File "/usr/lib/python2.7/site-packages/sphinx/application.py", line 207, in build
    self.builder.build_update()
  File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 198, in build_update
    'out of date' % len(to_build))
  File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 254, in build
    self.write(docnames, list(updated_docnames), method)
  File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 293, in write
    doctree = self.env.get_and_resolve_doctree(docname, self)
  File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 1117, in get_and_resolve_doctree
    doctree = self.get_doctree(docname)
  File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 1101, in get_doctree
    f = open(doctree_filename, 'rb')
IOError: [Errno 2] No such file or directory: '/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/build/doctrees/index.doctree'

A more elaborate error message I got on the terminal:

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/algorithms.rst:97: (ERROR/3) Unexpected indentation.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/algorithms.rst:360: (WARNING/2) Literal block expected; none found.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:354: (WARNING/2) Explicit markup ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:532: (ERROR/3) Unexpected indentation.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:546: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:549: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:550: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:560: (ERROR/3) Unexpected indentation.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:574: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:577: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:578: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:544: (ERROR/3) Undefined substitution referenced: "c|c|c|c".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:572: (ERROR/3) Undefined substitution referenced: "c|c|c|c".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:227: (WARNING/2) Inline literal start-string without end-string.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:679: (ERROR/3) Unexpected indentation.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:680: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:836: (ERROR/3) Unexpected indentation.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:837: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1268: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1564: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1597: (WARNING/2) Inline literal start-string without end-string.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1640: (WARNING/2) Explicit markup ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1641: (WARNING/2) Inline literal start-string without end-string.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1643: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1857: (ERROR/3) Unexpected indentation.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:1881: (WARNING/2) Inline emphasis start-string without end-string.

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:923: (ERROR/3) Unknown target name: "a".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:923: (ERROR/3) Unknown target name: "b".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:923: (ERROR/3) Unknown target name: "a".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:923: (ERROR/3) Unknown target name: "b".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:923: (ERROR/3) Unknown target name: "a".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/form_language.rst:923: (ERROR/3) Unknown target name: "b".

/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/user_manual.rst:45: (WARNING/2) Inline literal start-string without end-string.

WARNING: master file /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/index.rst not found
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/user_manual.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [ 11%] index
Exception occurred:
  File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 1101, in get_doctree
    f = open(doctree_filename, 'rb')
IOError: [Errno 2] No such file or directory: '/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/build/doctrees/index.doctree'
The full traceback has been saved in /tmp/sphinx-err-EXOl8C.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-dev/>,
or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

[Johannes Ring (johannr)]

You should be using scripts/makedoc instead.

[Marie Rognes (meg-simula)]

Try reading the README file under doc/sphinx:

meg@meg-laptop:~/local/fenics/src/ufl/trunk$ cat doc/sphinx/README
To build the documentation, run `scripts/makedoc` from the
top-level UFL directory. Running `make html` directly from
within this directory won't work (unless the makedoc script
has been run first).

--
Marie

On 09/12/11 15:03, Andre Massing wrote:
> Public bug reported:
>
> I tried either of these commands
> make html
> make dirhtml
> make singlehtml
> and could not build it because of the following error (from the error.log) :
> # Sphinx version: 1.0.7
> # Python version: 2.7.0
> # Docutils version: 0.7 release
> # Jinja2 version: 2.5.5
> Traceback (most recent call last):
> File "/usr/lib/python2.7/site-packages/sphinx/cmdline.py", line 188, in main
> app.build(force_all, filenames)
> File "/usr/lib/python2.7/site-packages/sphinx/application.py", line 207, in build
> self.builder.build_update()
> File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 198, in build_update
> 'out of date' % len(to_build))
> File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 254, in build
> self.write(docnames, list(updated_docnames), method)
> File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 293, in write
> doctree = self.env.get_and_resolve_doctree(docname, self)
> File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 1117, in get_and_resolve_doctree
> doctree = self.get_doctree(docname)
> File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 1101, in get_doctree
> f = open(doctree_filename, 'rb')
> IOError: [Errno 2] No such file or directory: '/home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject/python-ufl/ufl-1.0_beta2/doc/sphinx/build/doctrees/index.doctree'
>
>
> A more elaborate error message I got on the terminal:
>
> /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject
> /python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/algorithms.rst:97:
> (ERROR/3) Unexpected indentation.
>
> /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject
> /python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/algorithms.rst:360:
> (WARNING/2) Literal block expected; none found.
>
> /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject
> /python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:354:
> (WARNING/2) Explicit markup ends without a blank line; unexpected
> unindent.
>
> /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject
> /python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:532:
> (ERROR/3) Unexpected indentation.
>
> /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject
> /python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:546:
> (WARNING/2) Definition list ends without a blank line; unexpected
> unindent.
>
> /home/andre/Work/software/openSUSE/home:susetroll:sandbox:fenicsproject
> /python-ufl/ufl-1.0_beta2/doc/sphinx/source/user/examples.rst:549:
> (WARNING/2) Definition list ends without a blank line; unexpected
> unindent.
>
> /home/andre/Work/software/openSUSE/home:...

[Anders Logg (logg)]

On Mon, Sep 12, 2011 at 01:22:04PM -0000, Johannes Ring wrote:
> You should be using scripts/makedoc instead.

...and read the README file in the doc/sphinx directory. ;-)

  To build the documentation, run `scripts/makedoc` from the
  top-level UFL directory. Running `make html` directly from
  within this directory won't work (unless the makedoc script
  has been run first).

I added that file last time I did the same mistake.

--
Anders

[Andre Massing (massing)]

Yes great runs now. Could not find doc installation instruction in the README (just building rpms for openSUSE)
Thanks for pointing out that!

[Andre Massing (massing)]

On 09/12/2011 03:35 PM, Anders Logg wrote:
> On Mon, Sep 12, 2011 at 01:22:04PM -0000, Johannes Ring wrote:
>> You should be using scripts/makedoc instead.
>
> ...and read the README file in the doc/sphinx directory. ;-)

Rushed through installation, read only README in the main dir and then
went immediately to the sphinx dir and was tempted by seeing the make
file and its help message :)
--
Andre

>
> To build the documentation, run `scripts/makedoc` from the
> top-level UFL directory. Running `make html` directly from
> within this directory won't work (unless the makedoc script
> has been run first).
>
> I added that file last time I did the same mistake.
>
> --
> Anders
>