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.

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

XRef not working on GitHub. #18

Open
shreyanshanchlia opened this issue Jan 31, 2021 · 2 comments
Open

XRef not working on GitHub. #18

shreyanshanchlia opened this issue Jan 31, 2021 · 2 comments

Comments

@shreyanshanchlia
Copy link

shreyanshanchlia commented Jan 31, 2021

My issue is similar to #10
Xref is working when running locally using terminal. However when trying to automate it on GitHub, xref does not generate links.

@OscarAbraham
Copy link

OscarAbraham commented Feb 5, 2021

Hi, I was having lots of issues with xrefs and docFX. It took me half a day to realize how to fix it, but it's simple: one has to delete the docFX cache. To be clear, I don't know what went wrong in the first place, there's a lot that could have happened, but when things work again, docFX gets stuck with the broken stuff. I deleted the obj folder inside the docFX directory of a couple of projects with these kinds of problems, and they all worked again. Maybe that works for you?

@NormandErwan
Copy link
Owner

NormandErwan commented Feb 19, 2021

DocFX requires two conditions to generate xref links:

  1. Generating metadata from .csproj not from .cs files.
  2. Building the documentation with a valid Unity installation on the machine.

Therefore it requires to install and activate Unity before generating the docs to : (1) generate the .csproj and (2) allow DocFX to generate xref links.

I'm actively working on resolving these two problems on GitHub workflows.

This is similar to #14 here on GitHub workflows, there on a local machine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants