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
1 answer

How to stop docfx from escaping "\\" to "\" in c# xml comments?

I am creating some XML comments which contain LaTeX style matrix notation. When creating documentation using docfx the \\ character, which normally denotes a new row in the matrix, is converted to a \. Is there any way to prevent this…
tmren
  • 23
  • 6
0
votes
1 answer

MathJax Parenthesis - Missing or unrecognized delimiter for \right

I am using MathJax to attempt to render equations with .NET & DocFX. This equation gives Missing or unrecognized delimiter for \right error in the browser. \(D_{text{mi}} = 1 - \frac{U_{c}}{U_{i}} = C_{t} - 0.05 - \lbrack \left( 16C_{t} - 0.5…
Hardgraf
  • 2,566
  • 4
  • 44
  • 77
0
votes
1 answer

How to collect all xml-documentation from projects in solution with docfx?

I have structure of solution like…
LETSDRUM
  • 133
  • 4
0
votes
1 answer

DocFX - Unable to filter out public Method from API Documentation

I have the following method in my class library that I want to hide from API documentation: namespace com.contoso.myns { public class myclass { public static string CreateSomething() { //Do Stuff } …
Mike Bruno
  • 600
  • 2
  • 9
  • 26
0
votes
1 answer

Docfx saying succeeded but no output files are generated

When attempting to use Docfx to document a C# project I am running into an issue that is probably down to myself being a moron. However I have read through the docfx examples and I have not seen any obvious ways of rectifying the issue. When I run…
Ted
  • 1
0
votes
1 answer

docfx doesn't work when I update .NET framework

I am trying to use docfx to create documentation for a library. I need to use at least docfx version 2.18.3 because I need to create pdf documentation. Whenever I try to build the solution, docfx throws a warning that says "no metadata is generated.…
dima618
  • 67
  • 11
0
votes
1 answer

Docfx Russian language search

How to make docfx to search in Russian language? It searches English words just fine, but not Russian words. I tried to debug it and can see that it uses lunr library for search. How can I replace standard lunr library with Russian lunr in docfx?
Access Denied
  • 8,723
  • 4
  • 42
  • 72
0
votes
1 answer

Generate .php file rather than .html in docfx documentation

I have been generating documentation with Docfx and everything works fine. Docfx generates .html files which is as expected. However, since html files an be embedded in php files, I am looking for a way to generate the files as .php files rather…
Daniel Oppong
  • 158
  • 1
  • 10
0
votes
1 answer

How do I config docfx to include C# event handler delegates in document?

I have some event handler delegates in my project, and I want to include them into my auto-generated document with docfx. I know there is a filter option in docfx.json > metadata, but how could I config it? Any ideas? I have try to add a…
Albert Chang
  • 3
  • 2
0
votes
1 answer

.NET API Documentation with DocFX - How to properly display a method call in a code example

I'm trying to leverage the XML notation feature in Visual Studio in order to build documentation for an API I'm writing. I'm running into a problem where I can't figure out how to reference a method name in my code sample without automatically…
Mike Bruno
  • 600
  • 2
  • 9
  • 26
0
votes
1 answer

DocFX Documentation Missing for Event Parameters

I'm using DocFX framework to generate documentation for my .NET DLL. It gives a great experience with customization. However I'm just stuck with the fact that my public VB Events are included in documentation but the information related to…
Azaz ul Haq
  • 1,635
  • 2
  • 18
  • 46
0
votes
1 answer

Does docfx support 'include' tag in triple-slash comments

I try to generate API documentation for project that has include tags in triple-slash comments using DocFX. Included content present in Visual Studio IntelliSense and in documentation that is generated by SandCastle, but it is missing in…
Sergey Berezin
  • 1
  • 1
0
votes
1 answer

Using docfx.console fails to generate documentation

I installed docfx.console through the nuget package manager (visual studios 2017 15.7.3) into a test project. My project is a .net library with a singular class with a bit of xml documentation. When I build the project it creates a _site file with…
Sam H
  • 91
  • 1
  • 9
0
votes
1 answer

Markdown in Docfx file inclusion passing parameters

How to pass parameters to an included file? File inclusion works: [!include[file2](file2.md)] But I want to pass parameters. Something like: {% include "file2.md" with { "name": "x" } %} file2.md: # Hi {{name}}
Niels Steenbeek
  • 4,692
  • 2
  • 41
  • 50
0
votes
1 answer

Docfx not build and output other path

There are two responsibilities; before the first problem my project hierarchy this and I want for each project code to documentation for this i use docfx. first problem; I don't want the building code to be rebuilt. ex. docfx ./docs/docfx.json…
errorau
  • 2,121
  • 1
  • 14
  • 38
1 2 3
…
8
9