dotnet/docfx

Tools for building and publishing API documentation for .NET projects

jalley3

@jalley3

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?

Bill Hertzing

@BillHertzing

The site RealFaviconGenerator.net will create 10 files that ensures our documentation site has all the files needed to support favicon across many browsers. These 10 files have to be installed into the root of the documentation site. To keep the source repository cleanly organized, I'd like to store these 10 files in <reporoot>/assets/siteroot. Can DocFx copy the contents of <reporoot>/assets/siteroot into <reporoot>/_site during document generation? and if so, could someone share the .docfx snippet(s) necessary to accomplish it? Thanks!

Jokinko

@jozefchmelar

Hello. I have a code generation tool which processes PLC code to C# and I'm using docfx to generate documentation ..The problem is that the code generation tool will not generate a an object of type "UINT" but of type "System.Object" ...there's a a PLC type in the description part though... Do you think it is possible to write a plugin, which will parse the description and edit the type value? so I get Type : UIT, Description : Twin type UInt

TermWay

@TermWay_gitlab

Hello, Is there a way to have the same rendering using <see langword="null"/> and <c>null</null> or better with a link like in this page https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/strings/ which link the null keyword to the documentation ?

TermWay

@TermWay_gitlab

I did it directly with the source code. Goodbye!

Timon

@TimonPost

Using docfx 3, is there a example file on how to link projects to be documented? Have been looking in th v3 branch for references but could not find anything I was looking for. Thanks

1 reply

David Márquez Fàbrega

@DavidMarquezF

Are plugins already supported in the v3-release branch? I suppose now they will have to be written for the markdig processor no?

BrettGFleischer

@BrettGFleischer

Hi all, I am busy documenting a multi project solution. I have managed to generate the required .yml files in a separate folder for each project, however, some of the projects make reference to the same classes in an other shared project resulting in some nasty warnings:

Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ManagedReferenceDocumentProcessor.Save](ProjectA_sdk/ProjectB.Provider.Models.yml)Uid(ProjectB.Provider.Models) has already been defined in ProjectB-plugins/ProjectB.Provider.Models.yml.

Now I have tried several different variations of the exclude semantics inside of the src section within the docfx.json file but these files will just not be excluded. Sample of the excludes I have tried:

"exclude": [
            //"ProjectB.Provider/**.csproj",
            //"ProjectB.Provider/**",
            //"ProjectB.Provider/Models/**",
            "**/bin/**",
            "**/obj/**",
            "_site/**"
          ]

Is there anything I am missing W.R.T this exclude section? If not the next avenue I will explore is the Filtering of Unwanted APIs.

Morten Nielsen

@dotMorten

@BrettGFleischer It shouldn't be a problem if you just merge the two generated TOC's above with a new toc. ie:

 "metadata": [
    {
      "src": [
        {
          "files": [
            "Common/Common.csproj",            
          ],
          "src" : "../../../src/"
        }
      ],
      "dest": "../../../../../output/docs/api/Common",
      "properties": { "TargetFramework": "net6.0" },
    }, {
      "src": [
        {
          "files": [
            "Common.Utilities/Common.Utilities.csproj",
          ],
          "src" : "../../../src/"
        }
      ],
      "dest": "../../../../../output/docs/api/Common.Utilities",
      "properties": { "TargetFramework": "net6.0" },
    },
]

Then above the two output folders, create a toc.yml with something like this:

- name: Common
  href: Common/toc.yml
- name: Common.Utilities
  href: Common.Utilities/toc.yml

This root folder is what you'll point the build to

1 reply

Lake

@Lachee

hey, how can I make docfx listen to the DefineConstants property ? I keep trying to define UNITY_EDITOR but it isn't generating those files

Max Inno

@innomaxx

Hello. Is it possible to set default page instead of generating almost empty index.html? I would like make generated page from README.md as default

Lake

@Lachee

Since i didnt end up getting any help with adding scripting defines in non-csproj projects, I decided to make a csproj and do it that way

however, I am getting this error now:
```

[22-07-05 02:56:24.369]Warning:[MetadataCommand.ExtractMetadata](D:/Users/Lachee/Documents/Unity Projects/lachee-utilities/Packages/com.lachee.utilities/Docfx.csproj)Workspace failed with: [Failure] Msbuild failed when processing the file 'D:\Users\Lachee\Documents\Unity Projects\lachee-utilities\Packages\com.lachee.utilities\Docfx.csproj' with message: Could not load file or assembly 'System.Runtime.CompilerServices.Unsafe, Version=4.0.4.1, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' or one of its dependencies. The system cannot find the file specified.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1;netstandard2.0;netcoreapp3.0;net45</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <Compile Include="Scripts/**/*.cs" />
  </ItemGroup>

  <ItemGroup>
    <Compile Remove="**/*.meta" />
    <None Remove="**/*.meta" />

    <Compile Remove="**/*.asmdef" />
    <None Remove="**/*.asmdef" />

    <Compile Remove="Documentation~\**" />
    <None Remove="Documentation~\**" />
  </ItemGroup>

</Project>

{
    "metadata": [
        {
            "src": [
                {
                    "src": "..",
                    "files": [
                        "Docfx.csproj"
                    ]
                }
            ],
            "dest": "api"
        }
    ]
}

Rhys van der Waerden

@rhys-vdw

Is it possible to format primitives but their more recognized alias? E.g. float instead of System.Single

Calvin Wilkinson

@CalvinWilkinson

Hello everybody. I am new to docfx and I need to create a doc site that shows API documentation for different versions of my api. I have been looking for a way to do it and I cannot find a way or any tutorials. I know it doesn't do it out of the box and 3.0 which is in beta will provide that feature, but I need something until 3.0 is released. Any advice or resources on this would be awesome!!

Something simular to what docs.unity3d.com does

Where communities thrive

People

Repo info

Activity