dotnet/docfx

Tools for building and publishing API documentation for .NET projects

Sean Killeen

@SeanKilleen

There are also some references to a ".openpublishing.redirection.json" but I'm not sure if that applies in our case.

Cary

@cary-hu

two year passed, is there a way to generate chm files with docfx?

bitbonk

@bitbonk

Cary

@cary-hu

so said

sad

Cary

@cary-hu

DocFX no longer support?

shenjeff

@shenjeff

hi, does anyone know whether it is possible to use DocFX to document entity framework C# models? I have managed to get the fields I want, but I cant seem to find a way to extract the annotations for the field type. I have tried to create a simple plugin, but all I get is System.Composition.Hosting.CompositionFailedException: No export was found for the contract

Really scratching my head here, the documentation ironically for a documentator isn't very complete

Christian Findlay

@MelbourneDeveloper

Hi. I've tried everything but I cannot figure out how to filter out single types, or all types within a namespace. This is my filter: https://github.com/MelbourneDeveloper/Device.Net/blob/develop/docfx_project/filterconfig.yml and this is my config file https://github.com/MelbourneDeveloper/Device.Net/blob/develop/docfx_project/docfx.json . If anyone could help, that would be awesome.

WangQian

@w757703598

Does anyone know how to use the v3 version of Docfx?

Ken Domino

@kaby76

Folks, Does anyone know the XML markup in C# doc comments for the "Description" cell of the table that Docfx generates per C# field of a class? <summary> adds a paragraph of text under the field name. <remarks> adds a "Remarks" section. There are no XML tags in the official spec for C# that I can find. <description> does not work. There is nothing in the Docfx documentation either, but I see it here as proof that it can be done. I'm about to DotPeek the assembly to figure it out, but I shouldn't have to go this route. Terrible.

Ken Domino

@kaby76

I see the answer to my question is <value>. But, the table format produced is not good--it does not word wrap the description.

jalley3

@jalley3

hey guys, i want to add a metadata property to all the md files, but i only see my yaml files and no md ones that get created for my code based docs

jalley3

@jalley3

ok i figured that oen out

one*

in my generated class yml metadata files, there is no information regarding method attributes, i want to filter out specific methods from a class's method collection based on attribute but the attribute isnt showing up in the metadata

Joe4evr

@Joe4evr

which attribute specifically?

jalley3

@jalley3

EditorBrowsable

@Joe4evr

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]

i have set the filterConfig to filter it out

but that filter step is happening at the metadata stage (so the yml files are already built)

i see no mention of that attribute anywhere in any of the yml metadata files

(i am only generating pages for namespace/class/enum/interface, not method/property/etc)

any assistance would be greatly appreciated

jalley3

@jalley3

nvm the metadata step is correct, build is where the pages are generated

so still not sure why these methods are not being filtered out

jalley3

@jalley3

- exclude:
    hasAttribute:
        uid: System.ComponentModel.EditorBrowsableAttribute
        ctorArguments:
        - System.ComponentModel.EditorBrowsableState.Advanced

is it the word attribute at the end of the uid?

thats what they had in the example file

jalley3

@jalley3

anyone ?

jalley3

@jalley3

dotnet/docfx#7064 nvm i think it was a bug on their end

anyone know how to get the summary and type for inherited members?

Paul Pacheco

@paulpach

I see some betas for docfx v3, is it close to GA?

Cary

@cary-hu

Is there any way to convert YAML to XML? and the YAML is generate by DocFX

Mike

@mikejr83

Has anyone built a Docker image for DocFX 2.x that supports metadata creation for .NET Core applications? I've created my own image using knsit/docfx:latest as a base and then adding the .NET Core SDK over top of it. The problem I'm running into is that DocFX is using mono as the inner compiler:

[21-03-19 01:53:58.802]Info:[ExtractMetadata]Using mono /usr/lib/mono/msbuild/15.0/bin/MSBuild.dll as inner compiler.

This gives me the following error:

[21-03-19 01:53:58.942]Error:System.IO.DirectoryNotFoundException: Could not find a part of the path '/proc/self/task/8/fd/4'

I should mention that I'm attempting this on a Windows host, but the goal is to be able to get the image out to our CICD environment so that we can get our APIs to generate documentation on build.

Thomas Ibel

@tibel

dotnet/docfx#7050

Is someone from the DevTeam here that can answer this or at least forward to the responsible PM?

lectr1c

@lectr1c

Hello, I have a C# project using .NET Standard 2.0 and .NET 5, when setting up they get built into two separate sites, how can I combine them so they both show in the table of contents?

minecraftchest1

@minecraftchest1:matrix.org

[m]

Hello. I am trying to get docfx to build documentation for a NuGet package I own. However, even when creating a new docfx project from scratch and copying the files over, it does not build any documention.

I get this warning.

Build succeeded with warning.
[21-05-25 07:17:45.785]Warning:[MetadataCommand.ExtractMetadata]No metadata is generated for Minecraftchest1-utils.
        1 Warning(s)
        0 Error(s)

Is there something I need to do before building the site?

minecraftchest1

@minecraftchest1:matrix.org

[m]

My source code is at https://gitlab.com/minecraftchest1/nuget-packages/-/tree/main/Minecraftchest1-utils-docfx

Apparently I need to enable xml comments in my project.

minecraftchest1

@minecraftchest1:matrix.org

[m]

I am still having issues.

Bill Hertzing

@BillHertzing

Using docfx 2.57.2, it is not generating documentation for the new c# 9.0 records. Known issue?

Bill Hertzing

@BillHertzing

I see that dotnet/docfx#7191 asks the same question, was opened 2021-03-14, and has had no response....

Thomas Ibel

@tibel

I'm facing dotnet/docfx#7406 too. Any chance we get a new release in the next hours/days?

jalley3

@jalley3

can you add a custom 404 page?

Where communities thrive

People

Repo info

Activity