Add domain_types sphinx extension #110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jl-wynen
force-pushed
the
typehints-extension
branch
from
be4ab9f
to
df15997
Compare
| `sphinx-autodoc-typehints <https://github.com/tox-dev/sphinx-autodoc-typehints>`_ | ||
| implements formatting for typehints but often results in hard-to-read annotations | ||
| for :class:`typing.NewType`. | ||
| As those are ubiquitous when using Sciline, this extension improves formatting. |
There was a problem hiding this comment.
Suggested change
| As those are ubiquitous when using Sciline, this extension improves formatting. | |
| As those may be ubiquitous when using Sciline, this extension improves formatting. |
NewType might just be how we currently use it.
Comment on lines
39
to
42
| in internal modules. ``sciline.sphinxext.domain_types`` defines some default | ||
| aliases for Scipp, e.g., ``{'scipp._scipp.core.DataArray': 'scipp.DataArray', ...}`` | ||
| which means that occurrences of ``scipp._scipp.core.DataArray`` are rendered as | ||
| ``scipp.DataArray``. Aliases defined in ``sciline_domain_types_extra_aliases`` |
There was a problem hiding this comment.
Sciline is independent of Scipp. Should we keep this out of the project?
There was a problem hiding this comment.
Then we have to put it into the template to duplicate it across repos. Shouldn't be a problem, but this here seemed more convenient for our target audience.
There was a problem hiding this comment.
Is there a problem with putting it into the template? If not, I would suggest to move this there.
SimonHeybrock
approved these changes
Jan 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #61
This turns the formatter from scipp/copier_template#124 into a sphinx extension. I am going to add code to use it to the copier template.