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

adding links to first references of the vocabulary items #1272

Closed
wants to merge 29 commits into from

Conversation

sanbrock
Copy link
Contributor

No description provided.

@sanbrock
Copy link
Contributor Author

If base class reference is the same as the first reference, do not duplicate the information and have the same link listed twice

@sanbrock sanbrock linked an issue Jun 15, 2023 that may be closed by this pull request
@phyy-nx
Copy link
Contributor

phyy-nx commented Jun 15, 2023

Discussion from Code Camp:

  • Remove dependency on pynxtools, by adding the new function as new code either alongside or inside dev_tools/docs/nxdl.py
  • Instead of a verbose link to the dependecy (e.g. <NXxbase/entry>, use ... and a pop up tool tip that says "This field extends NXxbase/entry" with a link to NXxbase/entry.
  • The above may require a new Sphinx subpage dependency. That's ok. Example: https://sphinx-hoverxref.readthedocs.io/en/latest/

@sanbrock
Copy link
Contributor Author

Code Camp suggestions are implemented, the new format is
definition: (required) NX_CHAR🔗
with tootip of override: NXxbase/entry/definition
Also the external dependency pynxtools is removed and the code is integrated.

@sanbrock sanbrock requested a review from PeterC-DLS June 16, 2023 09:04
Copy link
Contributor

@PeterC-DLS PeterC-DLS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to refactor nexus.py to separate out the xml tree parsing and form another PR to add the nexus_file utility with its h5py dependency?

@sanbrock
Copy link
Contributor Author

Override linking has been modified, and collapsible documentation/enumeration has been added according to the CC discussion.

@PeterC-DLS
Copy link
Contributor

PeterC-DLS commented Jun 20, 2023

Could you rebase this change off the newly refactored method in nxdl_utils.py? This will remove the dependencies on h5py and click

@PeterC-DLS PeterC-DLS mentioned this pull request Jun 20, 2023
@sanbrock
Copy link
Contributor Author

yes, sure

pyproject.toml Show resolved Hide resolved
.gitignore Show resolved Hide resolved
MANIFEST.in Show resolved Hide resolved
Copy link
Contributor

@PeterC-DLS PeterC-DLS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I build the python package, it has a version of 0.0.0. Perhaps set it to something other than the default.

@domna
Copy link
Contributor

domna commented Jul 18, 2023

When I build the python package, it has a version of 0.0.0. Perhaps set it to something other than the default.

@PeterC-DLS You should now get a correct version when building the package

.gitignore Show resolved Hide resolved
@@ -0,0 +1,854 @@
# pylint: disable=too-many-lines
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@phyy-nx
Copy link
Contributor

phyy-nx commented Oct 19, 2023

Superseded by #1303

@phyy-nx phyy-nx closed this Oct 19, 2023
@PeterC-DLS PeterC-DLS deleted the link_first_reference branch February 8, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

Extend HTML documentation of base classes for overrides
4 participants