Giter VIP home page Giter VIP logo

docfx-seed's Introduction

docfx-seed

Build status

Description

This is a sample docfx documentation project. It contains .NET source code and markdown files. docfx.json is the configuration file for running docfx. docfx will generate a static website as similar to http://docascode.github.io/docfx-seed/index.html

How to run

Under Windows

Install from Nuget

  • Install Nuget.exe
  • Create a folder, e.g. C:\Tools\docfx, under the folder, nuget install docfx.console
  • Open command line:
set PATH=%PATH%;C:\Tools\docfx\docfx.console\tools
docfx docfx-seed\docfx.json --serve

Install from choco

choco install docfx
docfx docfx-seed\docfx.json --serve

Cross platform

> mono nuget.exe install docfx.console
> mono docfx.console/tools/docfx.exe docfx-seed/docfx.json

Further information about docfx

docfx is a tool to generate documentation towards .NET source code and markdown files. Please refer to docfx to get start. The docfx website itself is generated by docfx!

docfx-seed's People

Contributors

andreycha avatar chenkennt avatar hellosnow avatar mariusvolkhart avatar qinezh avatar superyyrrzz avatar vicancy avatar vwxyzh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docfx-seed's Issues

The sample does not work on Mono/OS X

If the goal of docfx is to be cross platform, then its sample should also be made the same way.

This sample can now only be compiled under Mono/OS X by switching DNVM to 1.0.0-rc1-update1,

dnvm list

Active Version              Runtime Architecture OperatingSystem Alias
------ -------              ------- ------------ --------------- -----
       1.0.0-rc1-final      coreclr x64          darwin          default
       1.0.0-rc1-final      mono                 linux/osx       
  *    1.0.0-rc1-update1    mono                 linux/osx       

But it gives the following error message,

docfx
Info: Loading plug-in... in phase Build Document
Info: Plug-in loaded (ConceptualDocumentProcessor, ManagedReferenceDocumentProcessor, ResourceDocumentProcessor, TocDocumentProcessor) in phase Build Document
Warning: Error opening solution /Users/lextm/docfx-seed/src/SampleClass1/SampleClass1.sln: The classes in the module cannot be loaded.. Ignored.
Warning: No metadata is generated for .
Info: No files are found with glob pattern **/*.yml, excluding <none>, under working directory 
Info: Start building document ... in phase Build Document
Info: Plug-in ConceptualDocumentProcessor: Loading document... in phase Build Document
Info: Plug-in ConceptualDocumentProcessor: Document loaded (count = 5). in phase Build Document
Info: Plug-in ConceptualDocumentProcessor: Preprocessing... in phase Build Document
Info: Plug-in ConceptualDocumentProcessor: Building... in phase Build Document
Info: Plug-in ConceptualDocumentProcessor: Postprocessing... in phase Build Document
Info: Plug-in ConceptualDocumentProcessor: Saving... in phase Build Document
Info: Plug-in TocDocumentProcessor: Loading document... in phase Build Document
Info: Plug-in TocDocumentProcessor: Document loaded (count = 2). in phase Build Document
Info: Plug-in TocDocumentProcessor: Preprocessing... in phase Build Document
Info: Plug-in TocDocumentProcessor: Building... in phase Build Document
Info: TOC file articles/toc.md inside articles/ is used in phase Build Document in file toc.yml
Info: Homepage articles/docfx_getting_started.md is used. in phase Build Document in file toc.yml
Error: Unable to find either toc.yml or toc.md inside api/. Make sure the file is included in config file docfx.json! in phase Build Document in file toc.yml
Warning: Warning in build phase : following document error:
Unable to find either toc.yml or toc.md inside api/. Make sure the file is included in config file docfx.json!
Warning: 

Build succeeded with warning.
Warning: Error opening solution /Users/lextm/docfx-seed/src/SampleClass1/SampleClass1.sln: The classes in the module cannot be loaded.. Ignored.
Warning: No metadata is generated for .
Warning: Warning in build phase : following document error:
Unable to find either toc.yml or toc.md inside api/. Make sure the file is included in config file docfx.json!
Error: Unable to find either toc.yml or toc.md inside api/. Make sure the file is included in config file docfx.json! in phase Build Document in file toc.yml
Warning: 

There are totally 3 Warning(s), 1 Error(s) in phase Build Completed.

Note that the Documentation folder in https://github.com/dotnet/docfx also gives this error message. So currently it seems no sample can work on OS X.

Release 2.52 does not generate C# API reference on Mac

The previous release, 2.51 works, both for our own projects and for the DocFX Seed project. 2.52 does work for the same projects on Windows.

With 2.52 (downloaded as a zip from the releases tab), generating the docs for the DocFX Seed project shows warnings about the project files in the command line output and the results are missing any HTML for the C# API files. An example warning is, "... SampleClass1.sln: Could not resolve type with token 010000ed from typeref (expected class 'Microsoft.Build.Construction.SolutionFile' in assembly 'Microsoft.Build, Version=15.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a')"

For our own projects, the command line output shows exceptions thrown relating to the project file and nothing is generated. First there is a warning, "Unity.Entities.csproj: The type initializer for 'Microsoft.Build.Collections.MSBuildNameIgnoreCaseComparer' threw an exception.. Ignored."
This is followed later with a NULL reference exception (shown below).

The full DocFX Seed command line output:
`
charleswMBP13TB:dfxtest charlesw$ mono ../docfx-2.52/docfx.exe docfx-seed/docfx.json --serve
[20-04-16 02:20:12.776]Info:[MetadataCommand.ExtractMetadata]Using mono /Library/Frameworks/Mono.framework/Versions/6.4.0/lib/mono/msbuild/15.0/bin/MSBuild.dll as inner compiler.
[20-04-16 02:20:12.902]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[20-04-16 02:20:13.435]Warning:MetadataCommand.ExtractMetadataError opening solution /Users/charlesw/Documents/dfxtest/docfx-seed/src/SampleClass1/SampleClass1.sln: Could not resolve type with token 010000ed from typeref (expected class 'Microsoft.Build.Construction.SolutionFile' in assembly 'Microsoft.Build, Version=15.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'). Ignored.
[20-04-16 02:20:13.454]Info:[MetadataCommand.ExtractMetadata]Cache for /Users/charlesw/Documents/dfxtest/docfx-seed/src/SampleClass1/SampleClass1.sln in /Users/charlesw/Documents/dfxtest/docfx-seed/src/SampleClass1/obj/xdoc/cache/final/645371506 is corrupted, rebuild...
[20-04-16 02:20:13.454]Info:[MetadataCommand.ExtractMetadata]Generating metadata for each project...
[20-04-16 02:20:13.460]Warning:[MetadataCommand.ExtractMetadata]No metadata is generated for .
[20-04-16 02:20:13.479]Info:[MetadataCommand]Completed Scope:MetadataCommand in 735.2815 milliseconds.
[20-04-16 02:20:13.608]Info:[BuildCommand]6 plug-in(s) loaded.
[20-04-16 02:20:13.613]Info:[BuildCommand]Post processor ExtractSearchIndex loaded.
[20-04-16 02:20:13.624]Info:[BuildCommand]No files are found with glob pattern **/*.yml, excluding , under directory "/Users/charlesw/Documents/dfxtest/docfx-seed/obj/api"
[20-04-16 02:20:13.651]Info:[BuildCommand]Markdown engine is markdig
[20-04-16 02:20:13.782]Info:[BuildCommand.BuildCore.Build Document]Max parallelism is 4.
[20-04-16 02:20:14.341]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor]Building 3 file(s) in TocDocumentProcessor(BuildTocDocument)...
[20-04-16 02:20:14.341]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ResourceDocumentProcessor]Building 1 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
[20-04-16 02:20:14.341]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ConceptualDocumentProcessor]Building 0 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
[20-04-16 02:20:14.341]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.RestApiDocumentProcessor]Building 10 file(s) in RestApiDocumentProcessor(BuildRestApiDocument=>ValidateRestApiDocumentMetadata=>ApplyOverwriteDocumentForRestApi)...
[20-04-16 02:20:14.355]Warning:BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor.Prebuild.BuildTocDocumentUnable to find either toc.yml or toc.md inside obj/api/. Make sure the file is included in config file docfx.json!
[20-04-16 02:20:15.009]Info:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]Applying templates to 6 model(s)...
[20-04-16 02:20:15.257]Info:[BuildCommand.BuildCore.Build Document]XRef map exported.
[20-04-16 02:20:15.380]Info:[BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing ExtractSearchIndex]Extracting index data from 7 html files
[20-04-16 02:20:15.474]Info:[BuildCommand.Postprocess]Manifest file saved to manifest.json.
[20-04-16 02:20:15.499]Info:[BuildCommand]Completed building documents in 1885.5855 milliseconds.
Serving "/Users/charlesw/Documents/dfxtest/docfx-seed/_site" on http://localhost:8080

[20-04-16 02:24:02.679]Info:[BuildCommand]Completed Scope:BuildCommand in 229199.6742 milliseconds.
[20-04-16 02:24:02.679]Info:Completed in 229937.8832 milliseconds

Build succeeded with warning.
[20-04-16 02:24:02.684]Warning:MetadataCommand.ExtractMetadataError opening solution /Users/charlesw/Documents/dfxtest/docfx-seed/src/SampleClass1/SampleClass1.sln: Could not resolve type with token 010000ed from typeref (expected class 'Microsoft.Build.Construction.SolutionFile' in assembly 'Microsoft.Build, Version=15.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'). Ignored.
[20-04-16 02:24:02.684]Warning:[MetadataCommand.ExtractMetadata]No metadata is generated for .
[20-04-16 02:24:02.684]Warning:BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor.Prebuild.BuildTocDocumentUnable to find either toc.yml or toc.md inside obj/api/. Make sure the file is included in config file docfx.json!
3 Warning(s)
0 Error(s)
`

The full output from one of our projects:

`
charleswMBP13TB:Samples charlesw$ mono ../../docfx-2.52/docfx.exe docs/docfx_toc_enabled.json --serve
[20-04-15 11:38:15.482]Info:[MetadataCommand.ExtractMetadata]Using mono /Library/Frameworks/Mono.framework/Versions/6.4.0/lib/mono/msbuild/15.0/bin/MSBuild.dll as inner compiler.
[20-04-15 11:38:15.784]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[20-04-15 11:38:16.702]Warning:MetadataCommand.ExtractMetadataError opening project /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: The type initializer for 'Microsoft.Build.Collections.MSBuildNameIgnoreCaseComparer' threw an exception.. Ignored.
[20-04-15 11:38:16.709]Info:[MetadataCommand]Completed Scope:MetadataCommand in 1291.8044 milliseconds.
[20-04-15 11:38:16.709]Error:Error extracting metadata for /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: System.NullReferenceException: Object reference not set to an instance of an object
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.SaveAllMembersFromCacheAsync () [0x00380] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.ExtractMetadataAsync () [0x000c0] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
[20-04-15 11:38:16.709]Info:Completed in 1295.6479 milliseconds

Build failed.
[20-04-15 11:38:16.713]Warning:MetadataCommand.ExtractMetadataError opening project /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: The type initializer for 'Microsoft.Build.Collections.MSBuildNameIgnoreCaseComparer' threw an exception.. Ignored.
[20-04-15 11:38:16.713]Error:Error extracting metadata for /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: System.NullReferenceException: Object reference not set to an instance of an object
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.SaveAllMembersFromCacheAsync () [0x00380] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.ExtractMetadataAsync () [0x000c0] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
1 Warning(s)
1 Error(s)
charleswMBP13TB:Samples charlesw$ mono ../../docfx-2.52/docfx.exe docs/docfx_toc_enabled.json
[20-04-16 02:09:11.944]Info:[MetadataCommand.ExtractMetadata]Using mono /Library/Frameworks/Mono.framework/Versions/6.4.0/lib/mono/msbuild/15.0/bin/MSBuild.dll as inner compiler.
[20-04-16 02:09:12.360]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[20-04-16 02:09:13.441]Warning:MetadataCommand.ExtractMetadataError opening project /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: The type initializer for 'Microsoft.Build.Collections.MSBuildNameIgnoreCaseComparer' threw an exception.. Ignored.
[20-04-16 02:09:13.448]Info:[MetadataCommand]Completed Scope:MetadataCommand in 1583.7488 milliseconds.
[20-04-16 02:09:13.448]Error:Error extracting metadata for /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: System.NullReferenceException: Object reference not set to an instance of an object
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.SaveAllMembersFromCacheAsync () [0x00380] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.ExtractMetadataAsync () [0x000c0] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
[20-04-16 02:09:13.448]Info:Completed in 1587.8387 milliseconds

Build failed.
[20-04-16 02:09:13.451]Warning:MetadataCommand.ExtractMetadataError opening project /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: The type initializer for 'Microsoft.Build.Collections.MSBuildNameIgnoreCaseComparer' threw an exception.. Ignored.
[20-04-16 02:09:13.452]Error:Error extracting metadata for /Users/charlesw/Documents/dots/Samples/Unity.Entities.csproj: System.NullReferenceException: Object reference not set to an instance of an object
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.SaveAllMembersFromCacheAsync () [0x00380] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
at Microsoft.DocAsCode.Metadata.ManagedReference.ExtractMetadataWorker.ExtractMetadataAsync () [0x000c0] in <36cbd452dc6f4b5d8daa3dce4c7355a8>:0
1 Warning(s)
1 Error(s)

`

Not able to apply statictoc Template to the documentation

Hi,

I am trying to apply the statictoc template to the documentation, for that have added the name of the template in the docfx.json file and also giving the "-t statictc" command line switch. However, it not able to proceed further after the following section. Is there anything else that has can be done in order to apply this template to the document.

Template_Error

docfx.json file:
statictocError

Broken Link out of the box

I downloaded this example, and followed the instructions. I installed docfx and ran docfx --serve in the directory containing the docfx.json file. It generated the documentation and started running the website, but the link to the api documentation is broken. I am facing the same issue with my personal project but it appears this is a deeper problem.
The help files are all there, but the index page is not brought over so there is no way to actually view the documentation.

There must be some other step that needs to be done to get this working, but I cannot find any examples or anything in the documentation to get this working properly.

I've attached some images that show the files that were generated, the homepage with the broken link, and the broken page.

broken link
missing page
files

Overwrite for REST API doesn't work with markdown engine 'markdig'

The content of specs/petstore-operations.md is not fully applied to the resulting site during build.

image

Steps to reproduce:

  • Download and install docfx 2.35.4.0
  • Clone this repo
  • Add "markdownEngineName": "markdig" to docfx.json because it's the default engine like mentioned here in the note section
  • Build the documentation
  • Open the documentation and navigate to REST API in the top bar

Everything is fine without the explicit markdown engine setting.

Current build is broken

The current project fails in appveyor, see the last part:

Attempting to gather dependency information for package 'docfx.console.2.18.4' with respect to project 'C:\projects\docfx-seed', targeting 'Any,Version=v0.0'
nuget.exe : Package 'docfx.console 2.18.4' is not found in the following primary source(s): 'C:\Users\appveyor\.nuget\packages\,https://www.myget.org/F/docfx/api/v3/index.json'. Please verify all your online package sources are 
available (OR) package id, version are specified correctly.
At line:3 char:5
+     & nuget install docfx.console -Version 2.18.4 -Source https://www ...
+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (Package 'docfx....fied correctly.:String) [], RemoteException
    + FullyQualifiedErrorId : NativeCommandError
 
& : The module 'docfx.console.2.18.4' could not be loaded. For more information, run 'Import-Module docfx.console.2.18.4'.
At line:4 char:7
+     & docfx.console.2.18.4\tools\docfx docfx.json
+       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (docfx.console.2.18.4\tools\docfx:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CouldNotAutoLoadModule
 
docfx build failed with exit code 1.

Are there any plans to change this? What is happening here?

Hosting integration

As a developer I would like to push my changes, have the CI build my docs and then publish them on the web. As for now I am responsible for building this pipeline, deploying etc.

There are great tools, such as @apphb (AppHarbor), that steamline this process.

Can you add some convenient integrations with cloud hosting platforms, such as AppHarbor and/or Azure.

Documentation in src\DotnetNew\class1.cs is not taken into account

After putting some documentation in src\DotnetNew\class1.cs and rerunning docfx, the newly entered information is not found in the generated documentation.

Contents of my Class1.cs file:

using System;

namespace DotnetNew
{
    /// <summary>
    /// This documentation should be available
    /// </summary>
    public class Class1
    {
        /// <summary>
        /// This method does something very interesting
        /// </summary>
        public void DoSomething()
        { }
    }
}

DocFx output:

C:\TFS\Git\docfx-seed>docfx docfx.json --serve
[19-07-10 08:22:22.906]Info:[MetadataCommand.ExtractMetadata]Environment variable VSINSTALLDIR is set to C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\, it is used as the inner compiler.
[19-07-10 08:22:23.233]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[19-07-10 08:22:23.719]Warning:[MetadataCommand.ExtractMetadata](C:/TFS/Git/docfx-seed/src/SampleClass1/SampleClass1.sln)Error opening solution C:/TFS/Git/docfx-seed/src/SampleClass1/SampleClass1.sln: Unable to load one or more of the requested types. Retrieve the LoaderExceptions property for more information.. Ignored.
[19-07-10 08:22:23.758]Info:[MetadataCommand.ExtractMetadata]'C:/TFS/Git/docfx-seed/src/SampleClass1/SampleClass1.sln' keep up-to-date since '10/07/2019 7:55:53', cached result from 'C:/TFS/Git/docfx-seed/obj/api' is used.
[19-07-10 08:22:23.762]Info:[MetadataCommand]Completed Scope:MetadataCommand in 864,6535 milliseconds.
[19-07-10 08:22:23.875]Info:[BuildCommand]6 plug-in(s) loaded.
[19-07-10 08:22:23.880]Info:[BuildCommand]Post processor ExtractSearchIndex loaded.
[19-07-10 08:22:23.917]Info:[BuildCommand]Markdown engine is markdig
[19-07-10 08:22:24.344]Info:[BuildCommand.BuildCore.Build Document]Max parallelism is 8.
[19-07-10 08:22:25.510]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor]Building 4 file(s) in TocDocumentProcessor(BuildTocDocument)...
[19-07-10 08:22:25.511]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ManagedReferenceDocumentProcessor]Building 0 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation)...
[19-07-10 08:22:25.513]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ConceptualDocumentProcessor]Building 0 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
[19-07-10 08:22:25.517]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ResourceDocumentProcessor]Building 1 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
[19-07-10 08:22:25.518]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.RestApiDocumentProcessor]Building 10 file(s) in RestApiDocumentProcessor(BuildRestApiDocument=>ValidateRestApiDocumentMetadata=>ApplyOverwriteDocumentForRestApi)...
[19-07-10 08:22:26.227]Info:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.UpdateContext]0 external references found in 1 xref maps.
[19-07-10 08:22:26.985]Info:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.UpdateContext]0 uids found in 1 xrefservice(s).
[19-07-10 08:22:27.116]Info:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]Applying templates to 7 model(s)...
[19-07-10 08:22:27.370]Info:[BuildCommand.BuildCore.Build Document]XRef map exported.
[19-07-10 08:22:27.525]Info:[BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing ExtractSearchIndex]Extracting index data from 31 html files
[19-07-10 08:22:27.604]Info:[BuildCommand.Postprocess]Manifest file saved to manifest.json.
[19-07-10 08:22:27.636]Info:[BuildCommand]Completed building documents in 3755,983 milliseconds.
Serving "C:\TFS\Git\docfx-seed\_site" on http://localhost:8080

API Documentation Doesn't Build

Hi,

I downloaded the master branch and did the build and serve command.
But when it runs the link for API Documentation doesn't work. however the rest api link and other sub links works fine.
When i run the serve command i got the following warning

Build succeeded with warning.
[17-04-28 09:47:27.967]Warning:Build Document.CompilePhaseHandler.TocDocumentProcessor.Prebuild.BuildTocDocumentUnable to find either toc.yml or toc.md inside api/. Make sure the file is included in config file docfx.json!
1 Warning(s)
0 Error(s)

when i run the metadata -f
i get this
Build succeeded with warning.
[17-04-28 09:58:31.736]Warning:No metadata is generated for BaseClass,SomeVbClass,CatLibrary.
1 Warning(s)
0 Error(s)

Not sure why it is not working.

I am on windows 10 vs 2017.

Access token

Heads up, you have what appears to be a secret in your source:
image

Fails to build on linux

I get the following error when building on linux.

docfx build
Loading docsets...
Loading config...
Restoring dependencies...
Building...
schema-not-found ./restapi/petstore.swagger.json(1,1): Unknown schema ''.
schema-not-found ./restapi/contacts_swagger2.json(1,1): Unknown schema ''.
schema-not-found ./toc.yml(1,1): Unknown schema ''.
liquid-not-found ./README.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
liquid-not-found ./articles/docfx_getting_started.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
liquid-not-found ./articles/engineering_guidelines.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
liquid-not-found ./restapi/toc.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
liquid-not-found ./index.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
liquid-not-found ./articles/toc.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
liquid-not-found ./articles/csharp_coding_standards.md(1,1): Liquid template is not found for mime type 'Conceptual', the output HTML will not be generated.
build done in 626.92ms

  3 Error(s), 7 Warning(s), 0 Suggestion(s)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.