Skip to content

Add documentation URL to pyproject.toml and use it in tool.xml - #11

Open
johnwduggan wants to merge 2 commits into
mainfrom
9-add-link-to-each-tools-documentation-website
Open

johnwduggan wants to merge 2 commits into
mainfrom
9-add-link-to-each-tools-documentation-website

Conversation

@johnwduggan

Copy link
Copy Markdown
Member

Summary of Changes

This adds the ability to specify a documentation URL in pyproject.toml that integrates with nova-trame and nova-dashboard to display the URL to users.

We could consider automatically creating tool documentation links that point to https://ndip.ornl.gov/docs/user_guide/tools/, but I'm not sure if this is what we want. Would be interested to hear your thoughts on this subject!

Checklist

  • The PR has a clear and concise title
  • Code is self-documented and follows style guidelines.
  • Automated tests are written and pass successfully.
  • Regression tests (e.g. manually triggered system tests, manual GUI/tool tests, ...) are performed to make sure the PR does not break anything (when applicable)
  • Readme file is present and up-to-date.

Documentation Updates

Additional Notes

@johnwduggan
johnwduggan requested a review from andrewfayres July 9, 2026 20:32
@johnwduggan johnwduggan self-assigned this Jul 9, 2026
@johnwduggan johnwduggan linked an issue Jul 9, 2026 that may be closed by this pull request
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.

Add link to each tool's documentation website

1 participant