-
-
Notifications
You must be signed in to change notification settings - Fork 198
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
Add make.bat for building breathe's documentation on Windows #970
Comments
Hello, Breathe Team. I submit a PR (#971) to close this issue, in which I implement the corresponding Click to expand the log(.venv) C:\Users\hwhsu1231\Repo\breathe>make html
Running doxygen: class.cfg
Running doxygen: concept.cfg
Running doxygen: define.cfg
Running doxygen: enum.cfg
Running doxygen: file.cfg
Running doxygen: func.cfg
Running doxygen: page.cfg
Running doxygen: relates.cfg
Running doxygen: author.cfg
Running doxygen: par.cfg
Running doxygen: parblock.cfg
Running doxygen: overload.cfg
Running doxygen: example.cfg
Running doxygen: include.cfg
Running doxygen: qtstyle.cfg
Running doxygen: jdstyle.cfg
Running doxygen: structcmd.cfg
Running doxygen: autolink.cfg
Running doxygen: restypedef.cfg
Running doxygen: afterdoc.cfg
Running doxygen: templ.cfg
Running doxygen: tag.cfg
Running doxygen: group.cfg
Running doxygen: diagrams.cfg
Running doxygen: memgrp.cfg
Running doxygen: docstring.cfg
Running doxygen: pyexample.cfg
Running doxygen: manual.cfg
Running doxygen: interface.cfg
Running doxygen: tinyxml.cfg
Running doxygen: nutshell.cfg
Running doxygen: alias.cfg
Running doxygen: rst.cfg
Running doxygen: inline.cfg
Running doxygen: namespacefile.cfg
Running doxygen: array.cfg
Running doxygen: inheritance.cfg
Running doxygen: members.cfg
Running doxygen: userdefined.cfg
Running doxygen: fixedwidthfont.cfg
Running doxygen: latexmath.cfg
Running doxygen: functionOverload.cfg
Running doxygen: image.cfg
Running doxygen: name.cfg
Running doxygen: union.cfg
Running doxygen: group.cfg
Running doxygen: struct.cfg
Running doxygen: struct_function.cfg
Running doxygen: qtsignalsandslots.cfg
Running doxygen: lists.cfg
Running doxygen: headings.cfg
Running doxygen: links.cfg
Running doxygen: parameters.cfg
Running doxygen: template_class.cfg
Running doxygen: template_class_non_type.cfg
Running doxygen: template_function.cfg
Running doxygen: template_type_alias.cfg
Running doxygen: template_specialisation.cfg
Running doxygen: enum.cfg
Running doxygen: define.cfg
Running doxygen: interface.cfg
Running doxygen: xrefsect.cfg
Running doxygen: tables.cfg
Running doxygen: cpp_anon.cfg
Running doxygen: cpp_concept.cfg
Running doxygen: cpp_enum.cfg
Running doxygen: cpp_union.cfg
Running doxygen: cpp_function.cfg
Running doxygen: cpp_friendclass.cfg
Running doxygen: cpp_inherited_members.cfg
Running doxygen: cpp_trailing_return_type.cfg
Running doxygen: cpp_constexpr_hax.cfg
Running doxygen: cpp_function_lookup.cfg
Running doxygen: c_file.cfg
Running doxygen: c_struct.cfg
Running doxygen: c_enum.cfg
Running doxygen: c_typedef.cfg
Running doxygen: c_macro.cfg
Running doxygen: c_union.cfg
Running doxygen: membergroups.cfg
Running doxygen: simplesect.cfg
Running doxygen: code_blocks.cfg
Running doxygen: dot_graphs.cfg
Running doxygen: programlisting.cfg
Running doxygen: decl_impl.cfg
Running doxygen: multifile.cfg
Running doxygen: auto.cfg
Running doxygen: class.cfg
Running doxygen: typedef.cfg
Running Sphinx v7.2.6
Using Doxygen v1.9.7
fatal: No names found, cannot describe anything.
C:\Users\hwhsu1231\Repo\breathe\documentation\source\../..\breathe\project.py:116: RemovedInSphinx80Warning: Sphinx 8 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead.
self._default_build_dir = os.path.dirname(app.doctreedir.rstrip(os.sep))
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 32 changed, 0 removed
C:\Users\hwhsu1231\Repo\breathe\documentation\source\../..\breathe\renderer\sphinxrenderer.py:2409: RemovedInSphinx80Warning: Sphinx 8 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead.
self.app.confdir + os.sep + project_path + os.sep + dot_file_path
reading sources... [100%] variable
C:\Users\hwhsu1231\Repo\breathe\documentation\source\specific.rst:195: WARNING: Invalid C++ declaration: Expected identifier in nested name. [error at 0]
^
C:\Users\hwhsu1231\Repo\breathe\documentation\source\specific.rst:195: WARNING: Error in declarator or parameters-and-qualifiers
If pointer to member declarator:
Invalid C++ declaration: Expected identifier in nested name. [error at 28]
struct ClassWithAnonEntities
----------------------------^
If declarator-id:
Invalid C++ declaration: Expected identifier in nested name. [error at 28]
struct ClassWithAnonEntities
----------------------------^
C:\Users\hwhsu1231\Repo\breathe\documentation\source\specific.rst:195: WARNING: Error in declarator or parameters-and-qualifiers
If pointer to member declarator:
Invalid C++ declaration: Expected identifier in nested name. [error at 27]
union ClassWithAnonEntities
---------------------------^
If declarator-id:
Invalid C++ declaration: Expected identifier in nested name. [error at 27]
union ClassWithAnonEntities
---------------------------^
C:\Users\hwhsu1231\Repo\breathe\documentation\source\tinyxml.rst:7: WARNING: Invalid C++ declaration: Expected identifier in nested name. [error at 0]
^
C:\Users\hwhsu1231\Repo\breathe\documentation\source\tinyxml.rst:7: WARNING: Invalid C++ declaration: Expected identifier in nested name. [error at 0]
^
C:\Users\hwhsu1231\Repo\breathe\documentation\source\tinyxml.rst:7: WARNING: Invalid C++ declaration: Expected identifier in nested name. [error at 0]
^
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] variable
generating indices... genindex done
writing additional pages... search done
copying images... [100%] ../../examples/specific/image/xml/imageExample.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 6 warnings.
The HTML pages are in build\html.
Build finished. The HTML pages are in build/html.
(.venv) C:\Users\hwhsu1231\Repo\breathe> Can you help me check if there's anything else that needs to be considered? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Feature Request
Hello, Breathe Development Team.
Can you provide
make.bat
for building breathe's documentation on Windows?Based on the contents of Makefile, it will need
make.bat
for doxygen, specific, and tinyxml as well.The text was updated successfully, but these errors were encountered: