You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
When writing cross-references inside the project, links become a bit too verbose. For example, if we have:
# module some.deep.nested.module_aclassA:
"""A class. We reference [B][some.deep.nested.module_b.B]. """classAA:
"""AA class. We reference [A][some.deep.nested.module_a.A]. """
# module some.deep.nested.module_bclassB:
"""B class. We reference [A][some.deep.nested.module_a.A]. """
Here references can get really difficult to write. Another alternative would be to write [some.deep.nested.module_a.A][], which saves a few chars (depending on the name of the leaf symbol), but then the produced documentation becomes too verbose if we are already at the context of a some.deep.nested package.
Describe the solution you'd like
Allow writing local cross-references using relative imports and local symbols. In the example above:
# module some.deep.nested.module_aclassA:
"""A class. We reference [B][.module_b.B]. """classAA:
"""AA class. We reference [A][]. """
# module some.deep.nested.module_bclassB:
"""B class. We reference [.module_a.A][]. """
Describe alternatives you've considered
Just using the fully qualified symbol as stated above.
Additional context
None really, just that I know it would be hard to implement :)
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
When writing cross-references inside the project, links become a bit too verbose. For example, if we have:
Here references can get really difficult to write. Another alternative would be to write
[some.deep.nested.module_a.A][]
, which saves a few chars (depending on the name of the leaf symbol), but then the produced documentation becomes too verbose if we are already at the context of asome.deep.nested
package.Describe the solution you'd like
Allow writing local cross-references using relative imports and local symbols. In the example above:
Describe alternatives you've considered
Just using the fully qualified symbol as stated above.
Additional context
None really, just that I know it would be hard to implement :)
The text was updated successfully, but these errors were encountered: