chore: Add a warning about relative path resolution. #9828
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's not obvious whether paths are resolved based on current working directory where docfx is called or based on location of `docfx.json` file. It's worth to be explicit about it in the documentation.
voroninp
changed the title
yufeih
added
the
documentation
yufeih
approved these changes
Apr 1, 2024
renovate bot
referenced
this pull request
in buehler/dotnet-operator-sdk
Apr 7, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://github.com/dotnet/docfx) | `2.75.3` -> `2.76.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.76.0`](https://github.com/dotnet/docfx/releases/tag/v2.76.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🎉 New Features - feat: Add DefineConstants supports for source file based build by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9707](https://github.com/dotnet/docfx/pull/9707) - feat: Add additional layout options to modern template by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9737](https://github.com/dotnet/docfx/pull/9737) - feat: Add pdfPrintBackground setting by [@​cjlotz](https://github.com/cjlotz) in [https://github.com/dotnet/docfx/pull/9742](https://github.com/dotnet/docfx/pull/9742) - feat: Update roslyn packages by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9753](https://github.com/dotnet/docfx/pull/9753) - feat: Publish nightly pre-release packages by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9788](https://github.com/dotnet/docfx/pull/9788) - feat: Add DLL references support for file-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9825](https://github.com/dotnet/docfx/pull/9825) - feat: Support DOCFX_SOURCE_REPOSITORY_URL by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9759](https://github.com/dotnet/docfx/pull/9759) - feat: Add feature to configure markdig extension by docfx.json configs. by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9820](https://github.com/dotnet/docfx/pull/9820) - feat: Support for all emphasis supported by MarkDig by [@​EMaderbacher](https://github.com/EMaderbacher) in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) ##### 🐞 Bug Fixes - fix: `docfx download` command behaviors by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9721](https://github.com/dotnet/docfx/pull/9721) - fix: Resolved .NET SDK version problem on source-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9713](https://github.com/dotnet/docfx/pull/9713) - fix: Don't overwrite `_disabledToc` when metadata is explicitly defined by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9741](https://github.com/dotnet/docfx/pull/9741) - fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9769](https://github.com/dotnet/docfx/pull/9769) - fix: Move script tags into head in modern template by [@​fuzzykiller](https://github.com/fuzzykiller) in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - fix: Broken examples problems when using inheritdoc tag by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9754](https://github.com/dotnet/docfx/pull/9754) - fix: NullReferenceException occurred when both include and exclude are null by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9786](https://github.com/dotnet/docfx/pull/9786) - fix: Change JsonSchema EvaluationOptions instance to shared object by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9807](https://github.com/dotnet/docfx/pull/9807) - fix: Bug fix Invalid documentation on type parameter [#​9755](https://github.com/dotnet/docfx/issues/9755) by [@​soniyaprasad77](https://github.com/soniyaprasad77) in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) ##### 🚀 Performance Improvements - perf: Optimize xrefmap.json file deserialization performance by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9824](https://github.com/dotnet/docfx/pull/9824) ##### 🔧 Engineering - chore: percy snapshot by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9747](https://github.com/dotnet/docfx/pull/9747) - chore: Add detailed error message for specific exceptions by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9746](https://github.com/dotnet/docfx/pull/9746) - chore: update pdfpig nuget package version by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9803](https://github.com/dotnet/docfx/pull/9803) ##### 📄 Documentation - docs: Split docfx CLI reference docs based on commands by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9708](https://github.com/dotnet/docfx/pull/9708) - docs: Update markdown documentation regarding MarkDig extension by [@​tbolon](https://github.com/tbolon) in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - docs: Update `docfx.json` config reference document by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9813](https://github.com/dotnet/docfx/pull/9813) - docs: Correct `docfx template` page title by [@​peitschie](https://github.com/peitschie) in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - docs: Add a warning about relative path resolution. by [@​voroninp](https://github.com/voroninp) in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) #### New Contributors - [@​EMaderbacher](https://github.com/EMaderbacher) made their first contribution in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) - [@​fuzzykiller](https://github.com/fuzzykiller) made their first contribution in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - [@​soniyaprasad77](https://github.com/soniyaprasad77) made their first contribution in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) - [@​tbolon](https://github.com/tbolon) made their first contribution in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - [@​peitschie](https://github.com/peitschie) made their first contribution in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - [@​voroninp](https://github.com/voroninp) made their first contribution in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) **Full Changelog**: dotnet/docfx@v2.75.3...v2.76.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm,before 6am" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/buehler/dotnet-operator-sdk). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
ian-buse
referenced
this pull request
in dh2i-devs/dotnet-operator-sdk
May 3, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://github.com/dotnet/docfx) | `2.75.3` -> `2.76.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.76.0`](https://github.com/dotnet/docfx/releases/tag/v2.76.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🎉 New Features - feat: Add DefineConstants supports for source file based build by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9707](https://github.com/dotnet/docfx/pull/9707) - feat: Add additional layout options to modern template by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9737](https://github.com/dotnet/docfx/pull/9737) - feat: Add pdfPrintBackground setting by [@​cjlotz](https://github.com/cjlotz) in [https://github.com/dotnet/docfx/pull/9742](https://github.com/dotnet/docfx/pull/9742) - feat: Update roslyn packages by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9753](https://github.com/dotnet/docfx/pull/9753) - feat: Publish nightly pre-release packages by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9788](https://github.com/dotnet/docfx/pull/9788) - feat: Add DLL references support for file-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9825](https://github.com/dotnet/docfx/pull/9825) - feat: Support DOCFX_SOURCE_REPOSITORY_URL by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9759](https://github.com/dotnet/docfx/pull/9759) - feat: Add feature to configure markdig extension by docfx.json configs. by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9820](https://github.com/dotnet/docfx/pull/9820) - feat: Support for all emphasis supported by MarkDig by [@​EMaderbacher](https://github.com/EMaderbacher) in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) ##### 🐞 Bug Fixes - fix: `docfx download` command behaviors by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9721](https://github.com/dotnet/docfx/pull/9721) - fix: Resolved .NET SDK version problem on source-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9713](https://github.com/dotnet/docfx/pull/9713) - fix: Don't overwrite `_disabledToc` when metadata is explicitly defined by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9741](https://github.com/dotnet/docfx/pull/9741) - fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9769](https://github.com/dotnet/docfx/pull/9769) - fix: Move script tags into head in modern template by [@​fuzzykiller](https://github.com/fuzzykiller) in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - fix: Broken examples problems when using inheritdoc tag by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9754](https://github.com/dotnet/docfx/pull/9754) - fix: NullReferenceException occurred when both include and exclude are null by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9786](https://github.com/dotnet/docfx/pull/9786) - fix: Change JsonSchema EvaluationOptions instance to shared object by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9807](https://github.com/dotnet/docfx/pull/9807) - fix: Bug fix Invalid documentation on type parameter [#​9755](https://github.com/dotnet/docfx/issues/9755) by [@​soniyaprasad77](https://github.com/soniyaprasad77) in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) ##### 🚀 Performance Improvements - perf: Optimize xrefmap.json file deserialization performance by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9824](https://github.com/dotnet/docfx/pull/9824) ##### 🔧 Engineering - chore: percy snapshot by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9747](https://github.com/dotnet/docfx/pull/9747) - chore: Add detailed error message for specific exceptions by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9746](https://github.com/dotnet/docfx/pull/9746) - chore: update pdfpig nuget package version by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9803](https://github.com/dotnet/docfx/pull/9803) ##### 📄 Documentation - docs: Split docfx CLI reference docs based on commands by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9708](https://github.com/dotnet/docfx/pull/9708) - docs: Update markdown documentation regarding MarkDig extension by [@​tbolon](https://github.com/tbolon) in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - docs: Update `docfx.json` config reference document by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9813](https://github.com/dotnet/docfx/pull/9813) - docs: Correct `docfx template` page title by [@​peitschie](https://github.com/peitschie) in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - docs: Add a warning about relative path resolution. by [@​voroninp](https://github.com/voroninp) in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) #### New Contributors - [@​EMaderbacher](https://github.com/EMaderbacher) made their first contribution in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) - [@​fuzzykiller](https://github.com/fuzzykiller) made their first contribution in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - [@​soniyaprasad77](https://github.com/soniyaprasad77) made their first contribution in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) - [@​tbolon](https://github.com/tbolon) made their first contribution in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - [@​peitschie](https://github.com/peitschie) made their first contribution in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - [@​voroninp](https://github.com/voroninp) made their first contribution in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) **Full Changelog**: dotnet/docfx@v2.75.3...v2.76.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm,before 6am" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/buehler/dotnet-operator-sdk). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
p-kostov
pushed a commit
to ErpNetDocs/docfx
that referenced
this pull request
Jun 28, 2024
](https://renovatebot.com){kind=link}
Add a warning about relative path resolution. It's not obvious whether paths are resolved based on current working directory where docfx is called or based on location of `docfx.json` file. It's worth to be explicit about it in the documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's not obvious whether paths are resolved based on current working directory where docfx is called or based on location of
docfx.jsonfile.It's worth to be explicit about it in the documentation.