I have a new Mkdocs and MkDoxy install, just trying things out on a big existing Doxygen C++ project in Windows (using PowerShell), but I get the below errors.
After digging into the errors and source I see that I needed to specify my config like this:
site_name: My Docs
plugins:
- mkdoxy:
doxygen-bin-path: C:\Users\me\apps\myproj\docs\source\Doxygen\doxygen.exe
projects:
myProjectCpp: # name of project must be alphanumeric + numbers (without spaces)
src-dirs: src # path to source code (support multiple paths separated by space) => INPUT
full-doc: True # if you want to generate full documentation
doxy-cfg: # standard doxygen configuration (key: value)
FILE_PATTERNS: "*.cpp *.h*" # specify file patterns to filter out
RECURSIVE: True # recursive search in source directories
Having a more illustrative error message and/or more obvious help docs (this isn't Advanced, this is just getting started in an unexpected way) would be very helpful. I'm not even sure the Advanced doc that mentions the doxygen-bin-path option is linked anywhere.
Thanks for all your work on this great project!
Details
C:\Users\me\apps\myproj> mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Start plugin MkDoxy
INFO - -> Start project 'myProjectCpp'
FileNotFoundError: [WinError 2] The system cannot find the file specified
Upon running build -v instead of serve, I get a more helpful error message:
INFO - -> Start project 'myProjectCpp'
Traceback (most recent call last):
File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.10_3.10.3056.0_x64__qbz5n2kfra8p0\lib\runpy.py", line 196, in _run_module_as_main
return _run_code(code, main_globals, None,
File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.10_3.10.3056.0_x64__qbz5n2kfra8p0\lib\runpy.py", line 86, in _run_code
exec(code, run_globals)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts\mkdocs.exe\__main__.py", line 7, in <module>
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\click\core.py", line 1157, in __call__
return self.main(*args, **kwargs)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\click\core.py", line 1078, in main
rv = self.invoke(ctx)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\click\core.py", line 1688, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\click\core.py", line 1434, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\click\core.py", line 783, in invoke
return __callback(*args, **kwargs)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdocs\__main__.py", line 286, in build_command
build.build(cfg, dirty=not clean)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdocs\commands\build.py", line 304, in build
files = config.plugins.on_files(files, config=config)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdocs\plugins.py", line 533, in on_files
return self.run_event('files', files, config=config)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdocs\plugins.py", line 507, in run_event
result = method(item, **kwargs)
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdoxy\plugin.py", line 124, in on_files
if doxygenRun.checkAndRun():
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdoxy\doxyrun.py", line 147, in checkAndRun
self.run()
File "C:\Users\me\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\site-packages\mkdoxy\doxyrun.py", line 130, in run
doxyBuilder = Popen(
File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.10_3.10.3056.0_x64__qbz5n2kfra8p0\lib\subprocess.py", line 971, in __init__
self._execute_child(args, executable, preexec_fn, close_fds,
File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.10_3.10.3056.0_x64__qbz5n2kfra8p0\lib\subprocess.py", line 1456, in _execute_child
hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
FileNotFoundError: [WinError 2] The system cannot find the file specified
I have a new Mkdocs and MkDoxy install, just trying things out on a big existing Doxygen C++ project in Windows (using PowerShell), but I get the below errors.
After digging into the errors and source I see that I needed to specify my config like this:
Having a more illustrative error message and/or more obvious help docs (this isn't Advanced, this is just getting started in an unexpected way) would be very helpful. I'm not even sure the Advanced doc that mentions the
doxygen-bin-path
option is linked anywhere.Thanks for all your work on this great project!
Details
Upon running build -v instead of serve, I get a more helpful error message: