Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

going wrong with doxygen + sphinx #430

Closed
ArrowYL opened this issue Apr 17, 2019 · 3 comments
Closed

going wrong with doxygen + sphinx #430

ArrowYL opened this issue Apr 17, 2019 · 3 comments

Comments

@ArrowYL
Copy link

ArrowYL commented Apr 17, 2019

Here is my conf.py(partial)

extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.imgmath',
'sphinx.ext.todo',
'breathe'
]

breathe_projects = {
"QPanda2 - Core":"../../xml/",
}

sys.path.append("C:\ProgramData\Anaconda3\Lib\site-packages\breathe")`

I want the final result like this
image

So i set doxygen xml =yes
here is my doxygen config
DOXYFILE_ENCODING = GB2312
PROJECT_NAME = "QPanda2 - Core"
OUTPUT_DIRECTORY = C:\Users\QuantumBYLZ061902\Desktop\Docs
CREATE_SUBDIRS = YES
ALLOW_UNICODE_NAMES = YES
OUTPUT_LANGUAGE = Chinese
EXTRACT_ALL = YES
EXTRACT_PACKAGE = YES
EXTRACT_STATIC = YES
HIDE_UNDOC_MEMBERS = YES
INPUT = D:\QPanda2\include\Core
INPUT_ENCODING = GB2312
RECURSIVE = YES
EXCLUDE = QPanda2/include/Core/VirtualQuantumProcessor/SingleAmplitude/TensorEngine.h
QPanda2/include/Core/VirtualQuantumProcessor/SingleAmplitude/TensorNode.h
QPanda2/include/Core/VirtualQuantumProcessor/SingleAmplitude/QuantumGates.h
EXCLUDE_PATTERNS = *.h
SOURCE_BROWSER = YES
GENERATE_HTMLHELP = YES
CHM_FILE = test.chm
HHC_LOCATION = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
CHM_INDEX_ENCODING = GB2312
TOC_EXPAND = YES
GENERATE_LATEX = NO
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
INCLUDE_FILE_PATTERNS = PROTECT=PRIVATE
CLASS_DIAGRAMS = NO
CALL_GRAPH = YES
CALLER_GRAPH = YES
DOT_PATH = "C:\Program Files (x86)\Graphviz2.37\bin"

Then i add doxygenindex in index.rst
.. doxygenindex:: module
But the wrong message is
image

How to solve this problems? thanks.

@svenevs
Copy link

svenevs commented Apr 17, 2019

Please try pinning Sphinx==1.8.5 in your docs setup. This error arose with Sphinx 2.x, unfortunately I haven't had time to get to the bottom of where it comes from and produce a meaningful error report here to begin trying to fix it.

@jakobandersen
Copy link
Collaborator

I think it is fixed with #411.

@svenevs
Copy link

svenevs commented Apr 22, 2019

I am closing this now that #411 is merged (thanks @jakobanderson!).

@ArrowYL please reopen if the latest breathe (4.13 at this time) does not fix your problem. Please use Sphinx 2+.

@svenevs svenevs closed this as completed Apr 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants