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
1
vote
0 answers

How to run DocFx plugins & post processors under docfx.console?

I have successfully integrated DocFx with a Visual Studio project, using docfx.console, as described here and here. Under this setup, the building of the project triggers DocFx to process the docfx.json and markdown files found under the project. I…
Laurence
  • 980
  • 12
  • 31
1
vote
1 answer

Why does DocFX serve content over an internal server?

I've just started studying DocFX. According to its official guide we build content with a command similar to docfx docfx.json --serve and then view the generated site from http://localhost:8080. My question is: if DocFX is a static site generator,…
Tekins
  • 119
  • 10
1
vote
0 answers

How to group methods by region or some other grouping method for documentation?

I have a large class that exposes many commands. When I create documentation for the class the methods are sorted alphabetically, but I would like to have them grouped by functionality. Is there a way (using Sand Castle Helpfile builder of DocFx) to…
Dabblernl
  • 15,831
  • 18
  • 96
  • 148
1
vote
0 answers

Replace the generated TOC.yml by custom TOC.yml

I'm using docfx to generate API documentation for my .Net project. I need different flavors of what can be shown to different customer types. When generating the metadata, the TOC.YML is generated as well, which is fine. However when the generating…
Bram Van Den Bossche
  • 21
  • 2
1
vote
1 answer

How to increase width of docfx article page (based-on default theme)?

I am using docfx 2.43.3 with own theme (based on default theme). This is the result: http://docs.example.com/. In this article page, http://docs.example.com/articles/add_more.html. How would you increase the width of this page (all page and main…
Vy Do
  • 46,709
  • 59
  • 215
  • 313
1
vote
1 answer

Generating pdf documentation from visual studio with docfx throws error: "wkhtmltopdf is a prerequisite when generating PDF"

I am using docfx to create documentation for a library. I have docfx installed as a NuGet package for visual studio and I would like to create PDF documentation from my solution. Every time I build the project, docfx throws an error that states…
dima618
  • 67
  • 11
1
vote
1 answer

How to serve docfx in docker container?

I have tried to build a docker image based on mono to serve a docfx documentation. Here is my dockerfile code : FROM mono:latest #Set environment ENV DOCFX_VER 2.40.12 COPY entrypoint.sh / RUN apt-get update \ && apt-get -y install wget zip \ …
Seb HO
  • 55
  • 1
  • 7
1
vote
1 answer

Simple API call within the context of DocFx preprocessor

I would like to know if it is possible to make a simple API call (e.g. GitHub API v3) within the context of a DocFx custom template preprocessor. I have been trying all sorts of different approaches, but nothing has fully worked so far. My goal is…
David Poindexter
  • 488
  • 4
  • 12
1
vote
1 answer

Why aren't my customized template files being applied by docfx when building with a custom template specified in docfx.json?

The docfx documentation site shows how to customize the various .partial files used in the default template (see https://dotnet.github.io/docfx/tutorial/walkthrough/advanced_walkthrough.html). I've followed those instructions, creating a new…
Brett Zook
  • 71
  • 6
1
vote
0 answers

DocFX (VB.net) - VB code comment not rendering properly

DocFX is not rendering VB code comment properly. It looks like its considering the comment quote as the beginning of a string. My code looks like: ''' ''' This class will help external applications to communicate with API and vice…
nabeel riaz
  • 11
  • 1
1
vote
1 answer

Continuous deployment of DocFx documentation using on-premises TFS

I am struggling to set up a continuous deployment process for a DocFX project, using on-premises TFS. The process is described here, however the example walk-through is for VSTS, and I have on-premises TFS (version 2013). The basic idea is to build…
Laurence
  • 980
  • 12
  • 31
1
vote
1 answer

DocFx Error after installing dotnet core 2.1.300

I've create a simple console application along with a simple docfx project. When I run the DocFX command to generate the documentation I get the following metadata warning and becuasue the warning leads to the documentation not being…
PsiMatrix
  • 61
  • 8
1
vote
0 answers

Getting Microsoft's DocFX to work in Visual Studio

I downloaded DocFX and installed it from http://dotnet.github.io/docfx/. I added it to my environment path. I then downloaded the sample solution from https://github.com/docascode/docfx-seed and opened it as a website project. (This sample already…
TheEdge
  • 9,291
  • 15
  • 67
  • 135
0
votes
1 answer

Docfx Umlaute get not created in html

I'm creating documentation using DocFX. When I build and run the documentation on my Mac, everything works fine. However, when I run it on my Windows machine, it appears that my browser cannot handle German 'Umlaute' (äöü). It displays question…
Kadlu
  • 31
  • 1
  • 6
0
votes
0 answers

Gather Error Message Documentation into a list

I have error messages scattered around the code and would like to gather them into one section of the output documentation. File 1: // E00123 File not found /usr/bin/local/myfile/YourProject // To resolve this error look in /usr/bin/local for your…
Be Kind To New Users
  • 9,672
  • 13
  • 78
  • 125
1 2 3
…
8 9