first of all thanks for the idea of breathe -- i think it will fill quite an important gap in the future.
We are currently running some tests to see if we can port all doxygen and some custom documentation for a multi-10k-line c++ project to sphinx.
Sadly, I already have problems with the testsuite and pasted the output below. Most likely, it may be due to software versions: I have both python3 and python2, where in arch linux python3 is named python:
> python --version
Python 3.1.3
> python2 --version
Python 2.7.1
> pacman -Qi docutils
Name : docutils
Version : 0.7-5
> sphinx-build
Sphinx v1.0.7
> doxygen --version
1.7.2
below is the output which throws me at the pdb console. do you have any idea what i could do to mitigate, or which of the software i should try downgrading first? unfortunately, i am not so familiar with all things python-ish.
(user@host): /home/user/bin/breathe/testsuite $
> make clean
rm -rf build/*
> ls -a *
Makefile pseudorst.py
build:
. .. doctrees html
source:
. class.rst conf.py credits.rst domains.rst embeddedrst.rst function.rst inline.rst nutshell.h specific.rst struct.rst tinyxml.rst
.. codeguide.rst contributing.rst directives.rst doxygen.rst enum.rst index.rst members.rst quickstart.rst _static testpages.rst typedef.rst
> make html
mkdir -p build/html build/doctrees
sphinx-build -b html -P -a -d build/doctrees source build/html
Running Sphinx v1.0.7
loading pickled environment... not yet created
building [html]: all source files
updating environment: 19 added, 0 changed, 0 removed
Exception occurred while building, starting debugger:
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 203, in build
self.builder.build_all()
File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 161, in build_all
self.build(None, summary='all source files', method='all')
File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 218, in build
purple, length):
File "/usr/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 120, in status_iterator
for item in iterable:
File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 519, in update_generator
self.read_doc(docname, app=app)
File "/usr/lib/python2.7/site-packages/sphinx/environment.py", line 664, in read_doc
pub.publish()
File "/usr/lib/python2.7/site-packages/docutils/core.py", line 203, in publish
self.settings)
File "/usr/lib/python2.7/site-packages/docutils/readers/__init__.py", line 69, in read
self.parse()
File "/usr/lib/python2.7/site-packages/docutils/readers/__init__.py", line 75, in parse
self.parser.parse(self.input, document)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/__init__.py", line 157, in parse
self.statemachine.run(inputlines, document, inliner=self.inliner)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 170, in run
input_source=document['source'])
File "/usr/lib/python2.7/site-packages/docutils/statemachine.py", line 233, in run
context, state, transitions)
File "/usr/lib/python2.7/site-packages/docutils/statemachine.py", line 454, in check_line
return method(match, context, next_state)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 2706, in underline
self.section(title, source, style, lineno - 1, messages)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 329, in section
self.new_subsection(title, lineno, messages)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 398, in new_subsection
node=section_node, match_titles=1)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 284, in nested_parse
node=node, match_titles=match_titles)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 195, in run
results = StateMachineWS.run(self, input_lines, input_offset)
File "/usr/lib/python2.7/site-packages/docutils/statemachine.py", line 233, in run
context, state, transitions)
File "/usr/lib/python2.7/site-packages/docutils/statemachine.py", line 454, in check_line
return method(match, context, next_state)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 2706, in underline
self.section(title, source, style, lineno - 1, messages)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 329, in section
self.new_subsection(title, lineno, messages)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 398, in new_subsection
node=section_node, match_titles=1)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 284, in nested_parse
node=node, match_titles=match_titles)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 195, in run
results = StateMachineWS.run(self, input_lines, input_offset)
File "/usr/lib/python2.7/site-packages/docutils/statemachine.py", line 233, in run
context, state, transitions)
File "/usr/lib/python2.7/site-packages/docutils/statemachine.py", line 454, in check_line
return method(match, context, next_state)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 2281, in explicit_markup
nodelist, blank_finish = self.explicit_construct(match)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 2293, in explicit_construct
return method(self, expmatch)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 2035, in directive
directive_class, match, type_name, option_presets)
File "/usr/lib/python2.7/site-packages/docutils/parsers/rst/states.py", line 2086, in run_directive
result = directive_instance.run()
File "../breathe/__init__.py", line 157, in run
finder = self.finder_factory.create_finder(project_info)
File "../breathe/finder/__init__.py", line 55, in create_finder
root = self.parser.parse(project_info)
File "../breathe/parser/__init__.py", line 22, in parse
raise ParserError(filename)
ParserError: ../examples/doxygen/class/xml/index.xml
> /home/user/bin/breathe/breathe/parser/__init__.py(22)parse()
-> raise ParserError(filename)
(Pdb) Traceback (most recent call last):
File "/usr/bin/sphinx-build", line 9, in <module>
load_entry_point('Sphinx==1.0.7', 'console_scripts', 'sphinx-build')()
File "/usr/lib/python2.7/site-packages/sphinx/__init__.py", line 67, in main
return cmdline.main(argv)
File "/usr/lib/python2.7/site-packages/sphinx/cmdline.py", line 204, in main
pdb.post_mortem(sys.exc_info()[2])
File "/usr/lib/python2.7/pdb.py", line 1267, in post_mortem
p.interaction(None, t)
File "/usr/lib/python2.7/pdb.py", line 210, in interaction
self.cmdloop()
File "/usr/lib/python2.7/cmd.py", line 130, in cmdloop
line = raw_input(self.prompt)
KeyboardInterrupt
make: *** [html] Error 1