Я использую docfx для создания документации для библиотеки.Я установил docfx в виде пакета NuGet для Visual Studio, и я хотел бы создать документацию в формате PDF из своего решения.Каждый раз, когда я собираю проект, docfx выдает ошибку, в которой говорится, что
wkhtmltopdf является обязательным условием при создании PDF.Пожалуйста, установите его из https://wkhtmltopdf.org/downloads.html и сначала сохраните исполняемую папку в% PATH%.В качестве альтернативы вы можете установить его с https://chocolatey.org с choco install wkhtmltopdf
.
У меня есть wkhtmltopdf, загруженный и добавленный в PATH.
У меня есть файл JSON, настроенный для создания документа PDF, и файл toc.yml
в папке с именем pdf
.
Файл JSON:
{
"metadata": [
{
"src": [
{
"files": [
"*.csproj"
],
"cwd": ".",
"exclude": [
"**/obj/**",
"**/bin/**",
"_site/**"
]
}
],
"dest": "obj/api"
}
],
"pdf": {
"content": [
{
"files": [
"api/**.yml"
],
"exclude": [
"**/toc.yml",
"**/toc.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md",
"pdf/*"
],
"exclude": [
"**/bin/**",
"**/obj/**",
"_site_pdf/**",
"**/toc.yml",
"**/toc.md"
]
},
{
"files": "pdf/toc.yml"
}
],
"resource": [
{
"files": [
"images/**"
],
"exclude": [
"**/bin/**",
"**/obj/**",
"_site_pdf/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"**/bin/**",
"**/obj/**",
"_site_pdf/**"
]
}
],
"dest": "_site_pdf"
}
}
toc.yml
Файл:
- name: Articles
href: ../articles/toc.yml
- name: Api Documentation
href: ../api/toc.yml
Структура папок решения моей библиотеки:
|- _site
|- api
|- index.yml
|- articles
|- intro.md
|- toc.md
|- pdf
|- toc.yml
|- docfx.json
|- toc.yml
|- index.yml
(Other visual studio solution files are in this folder)
Я ожидаюпапка _site_pdf, которая будет создана при создании решения, но я получаю сообщение об ошибке, в котором говорится, что файл wkhtmltopdf отсутствует, даже если он установлен и добавлен в путь.Я подозреваю, что проблема связана с моим файлом toc или JSON, но у меня очень мало опыта, поэтому я не могу найти проблему.