Skip to content
This repository has been archived by the owner on Aug 9, 2022. It is now read-only.

Doc generation not working even for basic example with latest releases #56

Closed
eaball35 opened this issue Dec 16, 2020 · 5 comments
Closed

Comments

@eaball35
Copy link

The latest releases of doclet are not working to generate documentation. However, I was able to successfully generate documentation with an older release.

Running into same error message as similar issue here: docfx - 6791.

OS Environment:
macOS Catalina v 10.15.7

Steps to Reproduce:

Expected Behavior:

  • Generate the docs.

Actual Behavior:

  • The yml files are all generated.
  • Only TOC generated when serve _site. All the rest is ignored.

Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.UpdateHref](yml/toc.yml)Unable to find file with uid [all generated yml files] referenced by TOC file "yml/toc.yml"

@anmeng10101
Copy link
Collaborator

@eaball35
Just would like to check if the document build engine is DocFx V2?

In recent docfx-doclet releases, we have breaking changes in yaml outputs to support docfx V3.

As you may noticed the header of yaml file changed
From
“### YamlMime:ManagedReference”
To
" ### YamlMime:Javaxxxxx"

If docfx V2 is using, June Release will be a working option.

@anmeng10101
Copy link
Collaborator

@eaball35
It is very welcome to use DocFx v3 if you would like.

dotnet/docfx at v3

dotnet tool update -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json

@andrei-punko
Copy link
Contributor

May be it's reasonable to note in README that v3 of DocFx is mandatory requirement for doclet usage

@eaball35
Copy link
Author

eaball35 commented Jan 5, 2021

Thanks for your reply. Yes, I am using docfx V2. I agree it may be helpful to include this in the README until V3 is fully released.

@eaball35 eaball35 closed this as completed Jan 5, 2021
@anmeng10101
Copy link
Collaborator

Thanks @eaball35 and @andrei-punko for suggestion, we've:

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants