Ensure BuildOptions can configure the output directory instead of forcing inline rendering

[rmannibucau]

No description provided.

[rmannibucau]

@dotnet-policy-service agree

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.86%. Comparing base (fe673ec) to head (f89ff73).
Report is 191 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9986      +/-   ##
==========================================
+ Coverage   74.31%   78.86%   +4.54%     
==========================================
  Files         536      540       +4     
  Lines       23189    23468     +279     
  Branches     4056     4065       +9     
==========================================
+ Hits        17234    18508    +1274     
+ Misses       4853     3820    -1033     
- Partials     1102     1140      +38     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[filzrev]

BuildJsonConfig has Output property that can be used to change output directory by setting this property.

docfx/src/Docfx.App/Config/BuildJsonConfig.cs

Lines 54 to 60 in 4f6f779

	/// <summary>
	/// Defines the output folder of the generated build files.
	/// Command line --output argument override this value.
	/// </summary>
	[JsonProperty("output")]
	[JsonPropertyName("output")]
	public string Output { get; set; }

Is there any missing features that can not be covered above solution?

---

Note:
There is following behavior differences. So it might need to explicitly set full path.

• When using BuildJsonConfig's Output property. relative path is resolved based on docfx.json config path.
• When using outputDirectory parameter. It's resolved based on current directory.

[rmannibucau]

Hi

One issue is the configuration is internal so programmatically it would require to generate a json file, I'd prefer something closer to docfx project api if possible.

[filzrev]

One issue is the configuration is internal

I've forgotten that BuildJsonConfig can't access programmatically because it's declared as internal.
I've requested to change these options to public before at #8872.
But currently there is no progress.

As a temporary workaround.
By using IgnoresAccessChecksToGenerator.
It can use RunBuild.Exec method directly instead of Docset.Build API.

Example configs of csproj

  <ItemGroup>
    <PackageReference Include="IgnoresAccessChecksToGenerator" Version="0.7.0" PrivateAssets="All" />
    <InternalsAssemblyName Include="Docfx.App" />
    <InternalsAssemblyName Include="Docfx.Dotnet" />
  </ItemGroup>

[rmannibucau]

@filzrev it would work but does it make sense to not expose what doxfx project uses or should docfx not use this output param anymore then?

[rmannibucau]

guess we can drop this PR is #10010 will reach main repo anytime soon, wdyt?