search

NormandErwan / DocFxForUnity

DocFX usage example for Unity projects
https://normanderwan.github.io/DocFxForUnity/
MIT License
213 stars 31 forks source link

XRef not working on GitHub. #18

Open shreyanshanchlia opened 3 years ago

shreyanshanchlia commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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.