Я работаю над проектом на Python и C ++ и хочу создать глобальную HTML-документацию. Для части Python я уже настроил sphinx для генерации документации. Это работает как шарм.
Но теперь приходит часть C ++.
Сначала я установил дыхание через пипс и последовал за Инструкция по началу работы.
Чтобы упростить тестирование, я создал простой проект на C ++ только с одним классом.
Я также создал необходимые XML-файлы с помощью Doxygen.
Теперь я хочу, чтобы sphinx генерировал документацию. Я выпустил sphinx-quickstart
со всем по умолчанию. После этого я добавил следующие строки в conf.py
файл:
extensions = ['breathe']
# -- Options for Breathe
breathe_projects = { "test": "/home/ubuntu/Downloads/testDocu/xml" }
breathe_default_project = "test"
Я также изменил index.rst
выглядеть так:
.. Test documentation master file, created by
sphinx-quickstart on Wed Jul 19 09:18:10 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Test's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
.. doxygenclass:: MyClass
:members:Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Но когда я сейчас бегу make html
Я получаю следующее сообщение об ошибке:
Exception occurred: File "/usr/lib/python2.7/dist-packages/docutils/transforms/universal.py", line 290, in apply
txtnode.parent.replace(txtnode, nodes.Text(newtext)) AttributeError: 'NoneType' object has no attribute 'replace' The full traceback has been saved in /tmp/sphinx-err-fLAGKW.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. A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks! make: *** [html] Error 1
Это ошибка или я что-то не так делаю?
Задача ещё не решена.
Других решений пока нет …