Is it possible to disable metadata build when using docfx en/docfx.json

[VaclavElias]

We have got lots of pages in manual and tutorial and if we would like to see some output of these pages, we don't need necessarily the APIs which takes extra time to build.

Is there any easy way to disable the metadata section through CLI, without manually commenting our paths in the src?

This is useful if we would like to see just manual and tutorial output lets say for the test purpose, and we are ok that that references are not resolved because APis are disabled.

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            //"sources/core/Stride.Core/Stride.Core.csproj",
            "sources/core/Stride.Core.IO/Stride.Core.IO.csproj",
            "sources/engine/Stride/Stride.csproj",
            "sources/core/Stride.Core.Mathematics/Stride.Core.Mathematics.csproj",
            "sources/core/Stride.Core.MicroThreading/Stride.Core.MicroThreading.csproj",
            "sources/core/Stride.Core.Serialization/Stride.Core.Serialization.csproj",
            "sources/engine/Stride.Audio/Stride.Audio.csproj",
            "sources/engine/Stride.Engine/Stride.Engine.csproj",
            "sources/engine/Stride.Games/Stride.Games.csproj",
            "sources/engine/Stride.Graphics/Stride.Graphics.csproj",
            "sources/engine/Stride.Input/Stride.Input.csproj",
            "sources/engine/Stride.Particles/Stride.Particles.csproj",
            "sources/engine/Stride.Rendering/Stride.Rendering.csproj",
            "sources/engine/Stride.Shaders/Stride.Shaders.csproj",
            "sources/engine/Stride.UI/Stride.UI.csproj",
            "sources/engine/Stride.VirtualReality/Stride.VirtualReality.csproj",
            "sources/engine/Stride.Navigation/Stride.Navigation.csproj"
          ],
          "src": "../../stride",
          "properties": {
            "TargetFramework": "net6.0",
            "StrideBuildDoc": "true"
          }
        },
        {
          "files": [
            "sources/assets/Stride.Core.Assets/Stride.Core.Assets.csproj",
            "sources/engine/Stride.Physics/Stride.Physics.csproj"
          ],
          "src": "../../stride",
          "properties": {
            "TargetFramework": "net6.0-windows7.0",
            "StrideBuildDoc": "true"
          }
        }
      ],
      "dest": "api",
      "filter": "filterConfig.yml",
      "includePrivateMembers": false,
      "disableGitFeatures": false,
      "disableDefaultFilter": false,
      "noRestore": false,
      "namespaceLayout": "flattened",
      "memberLayout": "samePage",
      "allowCompilationErrors": false
    }
  ],
  "build": {
    "globalMetadata": {
      "_appTitle": "Stride Docs",
      "_enableSearch": true,
      "_appLogoPath": "media/stride-logo-red.svg",
      "_appFooter": "<p>Hello World</p>"
    },
    "fileMetadata": {
      "_appTitle": {
        "tutorials/**/*.md": "Stride Tutorials",
        "manual/**/*.md": "Stride Manual",
        "ReleaseNotes/**/*.md": "Stride Release Notes",
        "api/**/*.md": "Stride API"
      }
    },
    "sitemap": {
      "baseUrl": "https://doc.stride3d.net/",
      "priority": 0.1,
      "changefreq": "monthly"
    },
    "content": [
      {
        "files": [
          "api/**.yml",
          "api/index.md",
          "tutorials/toc.yml",
          "tutorials/**/*.md",
          "ReleaseNotes/toc.yml",
          "ReleaseNotes/**/*.md",
          "manual/toc.yml",
          "manual/**/*.md"
        ]
      },
      {
        "files": [
          "articles/**.md",
          "articles/**/toc.yml",
          "toc.yml",
          "*.md"
        ]
      }
    ],
    "resource": [
      {
        "files": [
          ".nojekyll",
          "CNAME",
          "favicon.ico",
          "favicon.png",
          "images/**",
          "**/media/**/*.png",
          "**/media/**/*.jpg",
          "**/media/**/*.gif",
          "**/media/**/*.mp4",
          "**/media/**/*.zip",
          "**/media/**/*.svg",
          "**/media/**/*.webp",
          "**/media/**/*.cs"
        ],
        "exclude": [ "_site/**", "obj/**" ]
      }
    ],
    "dest": "_site",
    "globalMetadataFiles": [],
    "markdownEngineProperties": {
      "toc": {
        "levels": "1,2,3"
      }
    },
    "fileMetadataFiles": [],
    "template": [
      "default",
      "modern",
      "template"
    ],
    "postProcessors": [ "ExtractSearchIndex" ],
    "keepFileLink": false,
    "disableGitFeatures": false
  }
}

[yufeih]

Run docfx build to execute just the build command

[VaclavElias]

Thank you @yufeih.

I haven't realised we have got 3+ options here 🤦‍♂️. I guess I was pretty much confused even though I read the docs x times but it is now clear.

1. docfx en/docfx.json
2. docfx build en/docfx.json
3. docfx metadata en/docfx.json

[moonymachine]

Oh my gosh. You just blew my mind. 😄