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

Add support for Source Folder external URL #73

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

skyfex
Copy link

@skyfex skyfex commented Feb 18, 2022

I know this feature pull request is probably incomplete. Creating it to get feedback

This pull request creates a feature where each Source Folder can have an external URL attached, which can be used to generate a link to the source code of a definition in the documentation. Example

Source Folder: docs/uvm-src
   Name: UVM 1.2
   Url: https://github.com/accellera/uvm/blob/UVM_1_2_RELEASE/distrib/src/{filePath}#L{lineNum}

  • Can this feature be added?
  • What should I fix/improve to complete it?

@NaturalDocs
Copy link
Owner

I haven't looked at the source but I like this idea a lot.

Accepting code contributions has always been tricky because I currently own all the code except SQLite, which lets me do certain things like offer versions under other licenses. I would have to write up some sort of contributor agreement to accept code from others while still maintaining that, which I haven't gotten around to because there haven't been many. My other option is to just implement the idea myself without looking at your code, which I think I'm leaning towards, in which case we can treat this as a feature request.

@skyfex
Copy link
Author

skyfex commented Mar 9, 2022

It's fine by me to just donate the code and assign copyright to you. I'm in the process of double-checking with employer too.. Could you e-mail me at skyfex@gmail.com ?

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

Successfully merging this pull request may close these issues.

None yet

3 participants