2017-04-24 2 views
1

DocFXの設定に欠けているものがあります。そのため、適切なドキュメントが生成されません。 'src'フォルダへのDocFX相対パス

は、私は、次のフォルダ構造います

+Documentation 
|- _site 
|- api 
|- apidoc 
|- articles 
|- images 
|- src <-- This folder is autogenerated by `docfx init` command as a folders above 
    docfx.json 
    index.md 
    toc.md 
+packages 
|- Microsoft.NETCore.Platforms.1.0.1 
|- ... other nuget folders 
+src 
|- MyRealProject 
    |- assets 
    |- bin 
    |- Commands 
    |- obj 
    |- Properties 
    |- vendor  <- This folder should be excluded for documentation 
    app.config 
    MyRealProject.csproj 
    MyRealProject.csproj.user 
    Program.cs 
+test 
|-MyRealProjext.XUnit 
    |- bin 
    |- obj 
    |- Properties 
    app.config 
.gitattributes 
.gitignore 
.gitmodule 
MyRealProject.sln 

マイdocfx.json:index.htmlから代わりに上場http://locahost:8080オープンディレクトリに移動したときに

{ 
    "metadata": [ 
    { 
     "src": [ 
     { 
      "files": [ 
      "**/*.csproj" 
      ], 
      "exclude": [ 
      "**/obj/**", 
      "**/bin/**", 
      "_site/**", 
      "vendor/**" 
      ], 
      "src": "../src" 
     } 
     ], 
     "dest": "api" 
    } 
    ], 
    "build": { 
    "content": [ 
     { 
     "files": [ 
      "api/**.yml", 
      "api/index.md" 
     ] 
     }, 
     { 
     "files": [ 
      "articles/**.md", 
      "articles/**/toc.yml", 
      "toc.yml", 
      "*.md" 
     ], 
     "exclude": [ 
      "obj/**", 
      "_site/**" 
     ] 
     } 
    ], 
    "resource": [ 
     { 
     "files": [ 
      "images/**" 
     ], 
     "exclude": [ 
      "obj/**", 
      "_site/**" 
     ] 
     } 
    ], 
    "overwrite": [ 
     { 
     "files": [ 
      "apidoc/**.md" 
     ], 
     "exclude": [ 
      "obj/**", 
      "_site/**" 
     ] 
     } 
    ], 
    "dest": "_site", 
    "globalMetadataFiles": [], 
    "fileMetadataFiles": [], 
    "template": [ 
     "default" 
    ], 
    "postProcessors": [], 
    "noLangKeyword": false 
    } 
} 

はerrosなしでドキュメントを生成するコマンドdocfx buildを実行しているが、 _siteフォルダー。私はちょうどフォルダ一覧でWebページを参照してください意味: API/ apidoc/ 記事/ 画像/ _site/ など。 と私は_siteフォルダに入るとindex.htmlをクリックしても - それは開いてないしdocfxページを生成したが、トップの「APIドキュメント」をクリックし、テキストを示しています。それは正しく/ srcフォルダではなく/ドキュメント/ srcフォルダを読んでいましたので、TODO: Add .NET projects to the src folder and run docfx to generate REAL API Documentation!

  • 私はdocfx.jsonに何を再設定する必要がありますか?
  • vendor/フォルダをsrc/フォルダから除外する正しい方法ですか?

答えて

0

私の間違い。すべてが正常に機能しています。

私はGithubからコードをダウンロードしていて、ローカルでコンパイルしていました。この問題は、構成ファイルにはありませんでした(これは期待どおりに動作しますが)。なんらかの理由で、Githubのコードは 'デフォルト'のテンプレートもなくなる。したがって、最初のステップを実行した後でさえ、docfx.exe metadata - >メタデータが生成されましたが、テンプレートエンジンがないためにテーブルのコンテキスト(TOC)に変換されませんでした。したがって、docfx.exe build + serveを実行すると、空のサイトが表示されます。 「デフォルト」テンプレートの別のGithubページ