Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use docfx from dotnet tools #3037

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Use docfx from dotnet tools #3037

merged 1 commit into from
Nov 1, 2024

Conversation

pepone
Copy link
Member

@pepone pepone commented Nov 1, 2024

The C# docfx generation is currently not generating any HTML. There is a warning about templates being missing. I was able to reproduce locally when using the docfx installed with brew.

2024-11-01T09:50:42.4028480Z �[38;5;11mwarning: No template bundles were found, no template will be applied to the documents. 1) Check your docfx.json 2) the templates subfolder exists inside your application folder or your docfx.json directory.�[0m
2024-11-01T09:50:47.3596100Z �[38;5;15mBuilding 572 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>SplitClassPageToMemberLevel=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation)...�[0m
2024-11-01T09:50:47.3598460Z �[38;5;15mBuilding 1 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>ValidateConceptualDocumentMetadata)...�[0m
2024-11-01T09:50:47.3599510Z �[38;5;15mBuilding 2 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...�[0m
2024-11-01T09:50:47.3600680Z �[38;5;15mBuilding 2 file(s) in TocDocumentProcessor(BuildTocDocument)...�[0m
2024-11-01T09:50:50.3404030Z �[38;5;15mApplying templates to 577 model(s)...�[0m
2024-11-01T09:50:50.3407110Z �[38;5;11mwarning: UnknownContentTypeForTemplate: There is no template processing document type(s): Conceptual,ManagedReference,Toc�[0m
2024-11-01T09:50:50.9088260Z �[38;5;15mXRef map exported.�[0m

Things seems to work as expected when using docfx installed with dotnet tool install docfx -g

@pepone pepone requested a review from externl November 1, 2024 12:16
@pepone pepone merged commit da20abb into zeroc-ice:main Nov 1, 2024
18 of 19 checks passed
InsertCreativityHere pushed a commit to InsertCreativityHere/compiler-comparison that referenced this pull request Jan 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants