Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
    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
    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]
    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
    image.png
    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 ?
    image.png
    TermWay
    @TermWay_gitlab
    image.png
    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.