Stack Overflow
Stack Overflow

Questions tagged [docfx]

Docfx is a tool, to create documentation from visual studio projects and mixing them with custom articles using markdown. If you meet a bug or have a feature request, please open an issue on GitHub.

Docfx is a tool to create documentation from Visual Studio projects, mixing them with custom articles using markdown: https://dotnet.github.io/docfx/

If you meet a bug or have a feature request, please open an issue: https://github.com/dotnet/docfx/issues

130 questions
0
votes
0 answers

Can I remove empty entries in Doc FX ? Stuffs I did/can not write xml comments for

I'm using Doc FX for a C# project but I end up with some empty entries, like this: Which is an issue considering I'm pretty sure I cannot write my own xml comment for the int type^^ They are also some stuffs in my API that I didn't document on…
Slyp
  • 1
0
votes
1 answer

How to change the logo in DocFX?

I want to change the logo in DocFX which appears on the top left. I have replaced instances of logo.svg with my own logo.svg In docfx.json, the directory includes my logo: "resource": [ { "files": [ "images/**" ] …
Sienna
  • 83
  • 8
0
votes
0 answers

How can I cache docfx installation in my GitHub action?

I am writing a github action for which I need to install docfx. This step takes about 12 seconds: I know that npm install can be made super fast through caching, however npm has a package-lock you can use, but my docfx step is completely automatic…
CaseyHofland
  • 379
  • 2
  • 9
0
votes
0 answers

DocFX configuration setting to override default max directory depth?

In DocFX configuration (e.g., docfx.json), is it possible to override this max directory depth setting that appears to default to five (5)? While running a DocFX build, I'm getting a couple output lines complaining about some web font assets being…
patridge
  • 26,385
  • 18
  • 89
  • 135
0
votes
0 answers

"Improve this Document" link not appearing for vso (dev.azure.com) repository

"Improve this Document" link not appearing for vso repository from deployed code. "Improve this Document" link appear when debug from local code. Already set following setting in docfx file but doesn't work in deployed code "_disableContribution":…
vam
  • 3
  • 4
0
votes
0 answers

DocFX No .NET API detected for project

I used to be able to just build a DocFX page both locally and on gh-pages. But since recently, I keep getting a warning message: No .NET API detected for project. This happens both locally and on gh-pages, even when I install a fresh DocFX…
Tea-F-Tea
  • 113
  • 1
  • 8
0
votes
0 answers

Serving a docfx site from a fileshare (no webserver)

Is there a way to put the output of docfx build into a simple folder (e.g. local folder on my computer), load index.html and have the site load correctly? When I try this, the navigation is removed and I believe a base URL would need to be defined…
user1048175
  • 1,100
  • 3
  • 12
  • 29
0
votes
0 answers

Displaying summary information from one class in to another in docfx when in different projects

In docfx, I would like to take the summary from one class, and add it to another: namespace project1 { public class 1 { /// ///A summary about the method /// public void method(){} } } namespace…
David Moores
  • 1,025
  • 2
  • 9
  • 23
0
votes
1 answer

DocFX filter specific Classes

I'm really new to DocFx and I'm unable to filter some specific classes in my project. This is the docfx.json: { "metadata": [ { "src": [ { "files": ["**.dll"], "src": "../X3_Models/bin/Release/net7.0" …
McNets
  • 10,352
  • 3
  • 32
  • 61
0
votes
0 answers

DocFx.console v2.59.4 making a nested table span all columns

When I generate my docfx documentation, my Fields have the proper and columns. However, a nested table is created inside the description column that can be fairly large and it leaves the column with a lot of empty space…
user10614817
  • 13
  • 2
0
votes
1 answer

Markdown include section from another file

I want to include just a section from another markdown file in our documentation base. Our documentation is built in DocFx. I'm able to include the whole file but I just want a section from the file. For example, this…
Dannyboy
  • 197
  • 3
  • 12
0
votes
0 answers

DocFx - Invalid return type

I am working on static site documentation with docfx. I am facing a issue regarding the return type Method in a controller, In which I have a two produce response type for success and badrequest respectively. ` /// /// Endpoint…
Kanhaya Tyagi
  • 1
0
votes
1 answer

DocFx custom navigation

The default navigation in DocFx uses namespaces. So it looks like this: - MyNamespace.SomeArea - Class 1 - Class 2 - MyNamespace.SomeOtherArea - Class 3 - Class 4 However, we need to have the navigation tree using the actual folders of…
Maarty
  • 1,140
  • 1
  • 12
  • 27
0
votes
0 answers

Getting error in generating the PDF from wkhtmlpdf

I am generating the PDF from command line DocFX.exe. In same folder I kept wkhtmltopdf.exe to generate the pdf. The cmd to generate the html documentation works correctly, but I'm getting error in generating the PDF. I am using one docfx.json…
vam
  • 3
  • 4
0
votes
1 answer

c# DocFx. Direct way to create the web page or pdf of documentation?

I have my visual studio 2022 project with c# and I want to create the documentation but I don't want more files and folders to my project. Docfx create folders and files. SandCastle you even have to create another project inside your…
Rafael Alfredo Zelaya Amaya
  • 343
  • 4
  • 11
1 2 3
…
8 9