Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DocFx must use hacky/slow work around due to bug in VS2022 17.3 #1874

Closed
tig opened this issue Jul 21, 2022 · 4 comments · Fixed by #1881 or #1955
Closed

DocFx must use hacky/slow work around due to bug in VS2022 17.3 #1874

tig opened this issue Jul 21, 2022 · 4 comments · Fixed by #1881 or #1955
Labels
bug

Comments

@tig
Copy link
Collaborator

tig commented Jul 21, 2022 •
edited
Loading

My latest PRs broke the API docs.

I'm not sure why, but it appears to be something with the latest VS2022 builds.

I reverted to the 1.6.4 code and it docfx still fails:

[22-07-21 03:50:09.530]Info:Config file docfx.json found, start generating metadata...
[22-07-21 03:50:09.724]Info:[MetadataCommand.ExtractMetadata]Using msbuild C:\Program Files\Microsoft Visual Studio\2022\Preview\MSBuild\Current\Bin as inner compiler.
[22-07-21 03:50:10.281]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[22-07-21 03:50:14.000]Warning:[MetadataCommand.ExtractMetadata](C:/Users/charlie/s/gui.cs/Terminal.Gui/Terminal.Gui.csproj)Workspace failed with: [Failure] Msbuild failed when processing the file 'C:\Users\charlie\s\gui.cs\Terminal.Gui\Terminal.Gui.csproj' with message: Method not found: 'System.ReadOnlySpan`1<Char> Microsoft.IO.Path.GetFileName(System.ReadOnlySpan`1<Char>)'.
[22-07-21 03:50:15.025]Warning:[MetadataCommand.ExtractMetadata]Project 'C:\Users\charlie\s\gui.cs\Terminal.Gui\Terminal.Gui.csproj' does not contain any documents.

If @tznind or @BDisp can run docfx successfully please do so and submit a PR so we can get it fixed quick. Thanks.
@tig tig added the bug label Jul 21, 2022
BDisp added a commit to BDisp/Terminal.Gui that referenced this issue Jul 21, 2022
@BDisp
Fixes gui-cs#1874. API docs on github are broken.
9c9687a
@tig tig closed this as completed in a02dfea Jul 21, 2022
@tig
Copy link
Collaborator Author

tig commented Jul 22, 2022

Re-opening because with the latest VS2022 (Preview 4) I still can't get the docs to generate. Let's leave this open until we figure out why it's failing.

@tig tig reopened this Jul 22, 2022
@tig tig changed the title API docs on github are broken DocFx is failing with VS2022 17.3.0 Preview 4.0 Jul 22, 2022
@tig tig mentioned this issue Jul 22, 2022
Closed
@tig
Copy link
Collaborator Author

tig commented Jul 22, 2022

DocFx tracking issue and workaround: dotnet/docfx#8097

@tig tig mentioned this issue Jul 23, 2022
Merged
@tig tig closed this as completed in #1881 Jul 23, 2022
BDisp added a commit to BDisp/Terminal.Gui that referenced this issue Jul 26, 2022
@BDisp
Fixes gui-cs#1874. API docs on github are broken. (gui-cs#1875)
0d668bf 
* Fixes gui-cs#1874. API docs on github are broken.

* Rebuild with docfx 2.59.3.0 version.
tig added a commit that referenced this issue Aug 1, 2022
@BDisp @tig @tznind
Fixes #1861. Border: Title property is preferable to Text. (#1862)
49e2b95 
* Fixes #1861. Border Title property is preferable than the Text.

* Fixes #1866. Bug when scrolling text and type in a TextView. (#1868)

* Some fixes for the WebConsole support. (#1865)

* Invoking NotifyStopRunState for all situations.

* Added Clicked property to support web console.

* Changing to MoveDown to stay always visible.

* Fixes #1849. Wizard as non-popup is broken (#1853)

* trying to make it work

* Fixes #1849. Wizard as non-modal doesn't work

* Fixes #1855. Window and Frame content view without the margin frame.

* Fixing layout of non-modal

* WizardSTep is now a FrameView

* Now use Modal = false to set visual style automatically

* Removed Controls as an explicit construct. Now just Add to WizardStep

Co-authored-by: BDisp <[email protected]>

* Update docs with keybindings, global key event and designer (#1869)

* Added docs on keybinding and global key event

* Added TerminalGuiDesigner to showcases/examples

* Regenerated Docs (#1870)

* Fixed cancel logic. Title now shows for non-modal. (#1871)

* Fixes #1874. API docs on github are broken. (#1875)

* Fixes #1874. API docs on github are broken.

* Rebuild with docfx 2.59.3.0 version.

* Fixes Wizard cancel logic and updates docs (#1878)

* Fixed cancel logic. Title now shows for non-modal.

* trying to fix docs

* trying to fix docs

* Fixes #1867. Use Undo and Redo commands with WordWrap enabled. (#1877)

* Updated docs; regeneraged docs (#1881)

* Added a 'Read Only' to the Editor scenario Format menu. (#1882)

* Fixes #1883. Toplevel now propogates Loaded & Ready events to child Toplevel views.

* Updated API doc theme. Added Wizard Sample

* Tweaked API docs format and content. Fixed build warnings.

* Fixes #1889. Docs broken after org move.

* Regen API docs

* Fixes readme links to API docs

* Avoiding breaking change.

* Fixes typos.

* Passing string.Empty to Title from the default constructor.

* Initializes title with string.Empty instead of null.

Co-authored-by: Tig Kindel <[email protected]>
Co-authored-by: Thomas Nind <[email protected]>
@tig
Copy link
Collaborator Author

tig commented Aug 17, 2022 •
edited
Loading

Re-opening to fix for realz now that the underlying bug in VS has been fixed: dotnet/docfx#8135 (supposedly)

@tig tig reopened this Aug 17, 2022
@tig tig mentioned this issue Aug 17, 2022
Merged
@tig tig changed the title DocFx is failing with VS2022 17.3.0 Preview 4.0 DocFx must use hacky/slow work around due to bug in VS2022 17.3 Aug 17, 2022
@tig
Copy link
Collaborator Author

tig commented Aug 17, 2022

the real culprit is dotnet/msbuild#7832 which is NOT yet fixed.

#1955 will revert to the previous ./docfx/ build behavior after that issue is fixed (which is hopefully soon because the workaround is painfully slow).

@tig tig closed this as completed in #1955 Sep 16, 2022
tig added a commit that referenced this issue Sep 16, 2022
@tig
Docfx - revert hack for 1874 (#1955)
7a48424 
* Fixes #1874 (again)

* Fixes #1874 - Requires use docfx >= v2.59.4
tig added a commit that referenced this issue Sep 16, 2022
@tig
Force push to main to update api docs after fixing #1874
8cbb3ed
tig added a commit that referenced this issue Sep 16, 2022
@tig
Fixes #2025 - API Docs are now generated via Github Action - View Sou…
c6001c7 
…rce Works (#2027)

* Fixes #1991 - Broken link in README

* Force push to main to update api docs after fixing #1874

* Fixes #1745 - Github action to generate API docs

* Try 2 - Fixes #1745 - Github action to generate API docs

* Try 3 - Fixes #1745 - Github action to generate API docs

* Try 4 - Fixes #1745 - Github action to generate API docs

* Try 4 - Fixes #1745 - Github action to generate API docs

* Try 6 - Fixes #1745 - Github action to generate API docs

* Removed docs folder because gh-pages branch is now used

* Ignore ./docs folder

* Fix readme for docfx

* Revert "merge"

This reverts commit 870a241, reversing
changes made to 48089bb.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixes #1874. Works around DoxFx/VS2022 bug. Updated API docs.
Docfx - revert hack for 1874
1 participant
@tig