Debug docfx from Visual Studio

[VaclavElias]

I would like to debug docfx (main branch).

I can debug docfx from Visual Studio, but it doesn't generate html output, only none html.

Any advise what am I missing?

{
  "profiles": {
    "docfx": {
      "commandName": "Project",
      "commandLineArgs": "d:\\Projects\\GitHub\\stride-docs-next\\en\\docfx.json"
    }
  }
}

Command Line Logs

The command line logs show all the same like it was run from the command line (docfx en/docfx.json) when it generates the content except one line (which is at the bottom of the log):

There is no template processing document type(s): Conceptual,Toc

Using .NET Core SDK 6.0.407
No files are found with glob pattern bin/**/*.dll, excluding <none>, under directory "d:\Projects\GitHub\stride-docs-next\en"
No .NET API project detected.
Completed Scope:MetadataCommand in 365.3383 milliseconds.
Searching custom plugins in directory D:\Projects\GitHub\docfx\src\docfx\bin\Debug\net6.0\...
6 plug-in(s) loaded.
Post processor ExtractSearchIndex loaded.
Post processor SitemapGenerator loaded.
Building 45 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
Building 4 file(s) in TocDocumentProcessor(BuildTocDocument)...
Building 161 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\first-person-camera.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game09_FirstPersonCameraFirstPersonCamera.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\collision-triggers.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game02_Collision-TriggersCollisionTriggerDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\async-scripts.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game05_AsyncAsyncWebApi.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\audio.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game08_AudioAudioDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\animation-basics.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game07_AnimationAnimationBasics.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\removing-entities.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeRemoveEntitiesDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\async-scripts.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game05_AsyncAsyncCollisionTriggerDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\first-person-camera.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game10_ThirdPersonCameraCharacterMovement.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\audio.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game08_AudioLoadMusic.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\transform-position.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeTransformPositionDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\virtual-buttons.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeVirtualButtonsDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\loading-content.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeLoadingContentDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\linear-interpolation.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeLerpDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\keyboard-input.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeKeyboardInputDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\mouse-input.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeMouseInputDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\instantiating-prefabs.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeInstantiatingPrefabsDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\get-component.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeAmmoComponent.cs'.d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\child-entities.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeChildEntitiesDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\cloning-entities.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeCloneEntityDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\editor-properties.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodePropertiesDEmo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\delta-time.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeDeltaTimeDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\add-component.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeAmmoComponent.cs'.d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\entity.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeGettingTheEntityDemo.cs'.d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\get-component.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeGettingAComponentDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\add-component.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpBeginnerCSharpBeginnerCSharpBeginner.GameCodeAddingAComponentDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\project-and-unproject.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game04_Project-UnProjectProjectDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\navigation.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game11_NavigationNavigateCharacter.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\ui-basics.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game01_UI-BasicsUIByEditor.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\raycasting.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game03_RaycastingRaycastDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\ui-basics.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game01_UI-BasicsUIByCode.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\raycasting.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game03_RaycastingRaycastPenetratingDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\project-and-unproject.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game04_Project-UnProjectUnprojectDemo.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\scenes.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game06_ScenesLoadChildScene.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\third-person-camera.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game10_ThirdPersonCameraThirdPersonCamera.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\scenes.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game06_ScenesLoadScene.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpintermediate\third-person-camera.md: warning codesnippet-not-found: Invalid code snippet link: '........stridesamplesTutorialsCSharpIntermediateCSharpIntermediateCSharpIntermediate.Game10_ThirdPersonCameraCharacterMovement.cs'.
d:\Projects\GitHub\stride-docs-next\en\tutorials\csharpbeginner\loading-content.md(5,1): warning InvalidFileLink: Invalid file link:(~/manual/game-studio/manage-assets.md).
Applying templates to 210 model(s)...
There is no template processing document type(s): Conceptual,Toc
XRef map exported.
Sitemap file is successfully exported to d:\Projects\GitHub\stride-docs-next\en\_site\sitemap.xml
Manifest file saved to manifest.json.
Completed building documents in 1066.1812 milliseconds.
Completed Scope:BuildCommand in 1958.8684 milliseconds.


Build succeeded with warning.

    39 warning(s)
    0 error(s)


D:\Projects\GitHub\docfx\src\docfx\bin\Debug\net6.0\docfx.exe (process 36812) exited with code 0.
To automatically close the console when debugging stops, enable Tools->Options->Debugging->Automatically close the console when debugging stops.
Press any key to close this window . . .

[yufeih]

Run npm install and npm run build in templates folder to build the templates first.

[VaclavElias]

Maybe I found it..

This line here, it is expecting templates in that location, but who is going to copy them? I did manually 🤣

docfx/src/Microsoft.DocAsCode.Build.Engine/ResourceFinder.cs

Line 56 in dcc61b8

var directory = Path.Combine(AppContext.BaseDirectory, "templates", name);

The npm install and npm run build didn't copy it..

[VaclavElias]

I did now.

They seem to be built, do I need to nudge somehow the template path somewhere?

Then I run docfx from VS but the same result

[yufeih]

Aha, there is a symbol link to the templates folder, I guess it does not work very reliably on Windows.