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

Using filterConfig.yml with DocFX

I am new to DocFx and I am trying to configure DocFx to filter out DataSet information from a project and no matter how I enter it - it just doesn't work. The filterConfig.yml file has the following entries: apiRules: - exclude: uidRegex:…
Jim
  • 1
  • 1
0
votes
1 answer

Generate docfx site using existing docfx.json

So I have a docfx.json which is configured correctly and targets the correct directories. What I'm wondering is how can I generate site using that docfx.json from scratch. E.g. I have a blank directory with just the docfx.json in it and want to…
John_Mason27
  • 227
  • 4
  • 17
0
votes
2 answers

How to upload to a specific subfolder in Azure/static-web-apps-deploy GitHub Action

I have docfx project built by and deployed with GitHub workflow actions to an Azure Static Web App. For this specific project, I need the docfx generated files are uploaded to a specific subfolder (i.e "en-US"), so the documentation start site URL…
Igor Kondrasovas
  • 1,479
  • 4
  • 19
  • 36
0
votes
1 answer

Docfx failing on init command

I am trying to get docfx to generate a doc website based off of a C# library and I can't seem to get any of the commands covered in the documentation to work. On the quickstart page it states to use the following command to initialize a template…
John11141
  • 1
0
votes
0 answers

How to use docfx for git repo url?

how to use docfx where i have my source docfx.json from github or devops repo url? which way is feasible to use exe or nuget? i have one UI page where user will enter there repo path which has docfx.json I tried: docfx.exe but it won't take http…
Neo
  • 15,491
  • 59
  • 215
  • 405
0
votes
0 answers

DocFx shows just a small fraction of types and members

I tried several times to build a documentation site with DocFx. Every time I run docfx metadata and docfx build, the process runs without any errors, but DocFx lists just a few types and member of my project. I tried with several DocFx versions;…
Dominik Beyerle
  • 1
0
votes
1 answer

Disable toc items based on build parameter in DocFx

I am looking for a solution where I can change the generated output of a docfx build based on some parameters during build time. I have seen that there is a filter property in docfx.json where I can filter out some api stuff. But I would like to…
marco birchler
  • 1,566
  • 2
  • 21
  • 45
0
votes
0 answers

Is there a way to show conversion operator documentation on both types?

In C#, I have an implicit conversion operator (A) -> B defined on Type A. When creating the documentation with DocFx, the conversion operator only appears for type A, but not for type B. As a work-around, I tried to define the same conversion…
DhyMik
  • 333
  • 3
  • 12
0
votes
1 answer

DocFx fails to load System.Buffers.dll on Azure Pipelines

I am working on a Xamarin Forms project with Android target using Azure DevOps for CI. My project builds well in my local machine and also in the Azure Pipeline. Now, I would like to generate the code documentation with DocFx. So, I configured a…
Samuel LIOULT
  • 594
  • 5
  • 21
0
votes
0 answers

C# generating XML documentation

I have created a new C# WinForms project running on .NET Framework 4.7.2 and I would like to create a pdf documentation from XML generated file. I've managed to install VS docfx.console package as described in item 3 here. When I build my sollution,…
Peter Lakatoš
  • 65
  • 7
0
votes
1 answer

C# generated .XML file not including other file class

I am writing a C# winforms application, and I would like to create documentation for my code with XML comments. However, it seems like I am doing something wrong and can't figure out what is it. Currently, for generating HTML documentation I am…
Peter Lakatoš
  • 65
  • 7
0
votes
1 answer

Rendering docfx-built landing page from some html/javascript content

I have some .md files that are happily built into articles of a site generated by docfx. The landing page of this site which at the moment is a index.md file is empty. I have a separate static html page that its content is rendered by javascript…
daregazi
  • 65
  • 9
0
votes
1 answer

Change the Default icon for the ToC Items

Operating System: Windows DocFX Version Used: 2.56.1.0 Template used: default I was finding a way to change the default icon that shows up by the side of the toc items which is a "+" sign and which becomes a "-" sign once the list item is being…
Souradeep Banerjee-AIS
  • 117
  • 2
  • 10
0
votes
1 answer

Detect articles missing from a table of contents (toc.yml) file in DocFx

Sorry if this is an easy solution and I'm not aware. Assuming source files are in a directory like…
hcdocs
  • 1,078
  • 2
  • 18
  • 30
0
votes
0 answers

Docfx PDF Build in Azure DevOps

I have a docfx website that I have developed locally. I have added a pdf object in my docfx.json file in order to give a link for downloading the pdf of the website. I am using wkhtmltopdf for the same. It works fine locally and creates the pdf…
Souradeep Banerjee-AIS
  • 117
  • 2
  • 10
1 2 3
…
8 9