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

[Feature Request] Allow SourceLink support to be disabled #9991

Open
jskeet opened this issue Jun 7, 2024 · 0 comments
Open

[Feature Request] Allow SourceLink support to be disabled #9991

jskeet opened this issue Jun 7, 2024 · 0 comments
Labels
dotnet Generate .NET API reference docs

Comments

@jskeet
Copy link

jskeet commented Jun 7, 2024

Is your feature request related to a problem? Please describe.

I have xrefmap YAML files for dependencies of my library, with appropriate base URLs. Before docfx version 2.64.0, this meant that the generated documentation for my library would link to the generated documentation for my dependencies (e.g. for parameter types, return types, "see" elements etc). Great.

Since docfx 2.64.0, the links to documentation have been replaced by links to source code, for any dependencies which are generated with SourceLink. This isn't nearly as friendly IMO, and I'd like it to at least be configurable.

Describe the solution you'd like

Either:

  • Link to the documentation instead of the source if an xrefmap is provided
  • Allow a preference to be configured between "link to source" or "link to documentation"

Describe alternatives you've considered

I've looked to see if this is already available, and I can't find anything. I've tried to work out how I could "intervene" (e.g. by deleting pdb files) but there's nothing within my project's directory that looks like it would be suitable to do this.

Additional context

I can provide a repro if desired - it'll just take a little while to create a minimal one.

@yufeih yufeih added the dotnet Generate .NET API reference docs label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

2 participants