Как объединить MKDOC с модулями Pybind11? ⇐ C++

[Anonymous]

Я пытаюсь создать сайт документации для Python API, который создается с помощью Pybind11 с использованием MKDOC. Этот API также имеет API .cpp , который генерируется хорошо.

Код: Выделить всё

#include
namespace App::Binding
{
namespace py = pybind11;
}
< /code>
и API для приведенного выше приложения определяется в этом заголовке C +++ .cpp < /code> файлы:
h файл: < /p>
#pragma once
#include "PybindCommon.h"

namespace App::Binding
{
/**
* @brief Bindings for IApp API
*/
void bindApp(py::module_& m);
}    // namespace App::Binding
< /code>
cpp -файл: < /p>
#include "IApp.h"
#include "AppBindings.h"

#include 

/**
* @brief Bindings for IApp API
*/
namespace App::Binding
{
// Custom deleter for unique_ptr objects to call release() on the object when the object is GC'd in Python
struct AppDeleter
{
void operator()(IApp* app)
{
if(app) {
app->release();
}
}
};

void bindApp(py::module_& m)
{
// python constructor will be binded to a unique_ptr object with a custom deleter on C++ side
py::class_(m, "App",
R"pbdoc(
The main entry point for accessing the App.
Exposes general app metadata objects for accessing specific data from the app.
)pbdoc")
.def(py::init([](const char* config_path, LibType lib_type) {
IApp* app = initApp(config_path, lib_type);
if(app == nullptr) {
throw std::runtime_error(
"Can only construct one app per process. Multi-app support planned in future versions.");
}
return std::unique_ptr(app);
}),
py::arg("config_path"),
py::arg("lib"),
R"pbdoc(
Create an app object

Args:
config_path (:obj:`str`):
Path to the configuration file for the app.
lib (:obj:`LibType`):
Type of shared-object to use the app with.

Returns:
:obj:`App`:
App object.

Raises:
RuntimeError: If an App was already previously created in the same process.  Will be fixed in future versions.
)pbdoc")
.def(
"get_range",
[](const IApp& self) {
uint32_t first, last;
self.getRange(first, last);
return py::make_tuple(first, last);
},
R"pbdoc(
Get the App legal range

Returns:
:obj:`tuple`:
A tuple containing:
- first (:obj:`int`):
First range value.
- last (:obj:`int`):
Last range value.
)pbdoc")
.def("get_version",
&IApp::getVersion,
R"pbdoc(
Get the created App version

Returns:
:obj:`str`:
SHA of the App version.
)pbdoc")
.def("get_fps",
&IApp::getAppFps,
R"pbdoc(
Get the FPS of the App

Returns:
:obj:`int`:
App's system FPS.
)pbdoc")
.def("get_available_frames",
&IApp::getAvailableFrames,
R"pbdoc(
Get the available frames for the primary app sensor

Returns:
:obj:`list`:
List of available frames for the primary sensor.
)pbdoc")
.def("get_available_frame_configs",
&IApp::getAvailableFrameConfigs,
py::arg("frame"),
R"pbdoc(
Get all the available configurations for a specific frame type.

Args:
frame (:obj:`FrameType`):
Type of frame.

Returns:
:obj:`list`:
List of available configurations.
)pbdoc");
}
}    // namespace App::Binding

Я использовал Sphinx с Doxygen Up UP для создания статических HTML -файлов и генерирования их на локальный сайт с API, и мой офис начал использовать MKDOC (что, конечно, намного лучше), и теперь мне нужно каким -то образом извлечь API выше, используя MKDocs.yaml < /ul>
Это моя текущая конфигурация файла mkdocs.yaml, которую я представлял до сих пор: < /p>

Код: Выделить всё

site_name: "App Docs"
repo_url: /app.git
repo_name: app
edit_uri: edit/master/include/

dev_addr: 0.0.0.0:38000
docs_dir: .

plugins:
- mkdoxy:
projects:
App:
src-dirs: include
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h* *.md"
RECURSIVE: YES
INPUT: include
GENERATE_XML: YES
EXTRACT_ALL: YES
OPTIMIZE_OUTPUT_FOR_C: YES
pyDAST:
src-dirs: docs/build/json/python
doxy-cfg:
FILE_PATTERNS: "*.fjson"
RECURSIVE: NO
INPUT: docs/build/json/python
GENERATE_XML: YES
EXTRACT_ALL: YES
OPTIMIZE_OUTPUT_FOR_JAVA: YES
save-api: .mkdoxy
full-doc: True
debug: False
ignore-errors: False
- search
- mkdocstrings
- open-in-new-tab
- autorefs
- same-dir
- awesome-pages
- include-markdown

theme:
name: material
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.path
- navigation.top
- navigation.tracking
palette:
- media: "(prefers-color-scheme: dark)"
scheme: default
primary: blue
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: slate
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode

extra_javascript:
- https://cdn.jsdelivr.net/gh/rod2ik/cdn@main/mkdocs/javascripts/massilia-graphviz.js

markdown_extensions:
- extra
- tables
- mkdocs_graphviz
- attr_list
- mdx_truly_sane_lists
- mdx_math:
use_gitlab_delimiters: True # for $`...`$ style math
- toc:
permalink: true
- pymdownx.highlight
- pymdownx.superfences
- def_list
- admonition
- pymdownx.details
- markdown.extensions.md_in_html
- pymdownx.snippets:
check_paths: true
- pymdownx.blocks.admonition:
types:
- new
- settings
- note
- abstract
- info
- tip
- success
- question
- warning
- failure
- danger
- bug
- example
- quote
- pymdownx.blocks.details:
- pymdownx.blocks.html:
- pymdownx.blocks.definition:
- pymdownx.blocks.tab:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg

use_directory_urls: True

nav: ...

знакомы с каким -то плагином или методом для объединения этих двух?

Подробнее здесь: https://stackoverflow.com/questions/795 ... 11-modules