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

How to not generate source file links? #501

Closed
jumpinjackie opened this issue May 13, 2017 · 4 comments
Closed

How to not generate source file links? #501

jumpinjackie opened this issue May 13, 2017 · 4 comments

Comments

@jumpinjackie
Copy link

Is there a setting to not have typedoc generate source file links (ie. The "Defined in URL_to_source _and_line_number")?

I have no need for this feature and it results in very noisy commits whenever I run typedoc and put the output into /docs on master branch because blob URLs for referenced sources changes every time

@jonchardy
Copy link
Contributor

You can do this by modifying the theme if you'd like. That's the route we took.

In the theme project, you'll want to update src/default/partials/member.declaration.hbs and src/default/partials/member.signature.body.hbs. See the following commit: Don't include source information.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented May 14, 2019

Closing in favor of #808 as it seems to have more visibility.

@Gerrit0 Gerrit0 closed this as completed May 14, 2019
@crhistianramirez
Copy link

crhistianramirez commented Aug 4, 2019

A middleground option that allows you to keep "defined in", but generates a less noisy output is to output just the filename and line in src/default/partials/member.declaration.hbs

<li>Defined in {{fileName}}:{{line}}</li>

It would be even nicer if there was a feature that generated the link from the master branch instead of from the unique commit. That way it would only generate changes if the file structure changed and unless you were keeping multiple versions of documentation it would just work.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 4, 2019

You can specify --gitRevision to tell TypeDoc what to use instead of the current ish.

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

4 participants