sphinx-notes / sphinx-notes/any
Record and show relationship of objects
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 7
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Cross references
- Add an
.. any:obj.xref:: {{ unique }}directive for listing cross references of object? - Record the references relationship
AnyDomain.process_xref- document -> object
- object -> object (and the revverse reference)
Parent
- Add a
{{ parent }}template variable for object - Maintain an object stack when calling a directive's
runmethod, so we can know the parent of objects.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin by locating AnyDomain.process_xref and the directive run method. Trace how document-to-object and object-to-object references are currently processed, then determine where an object stack and parent template value belong. Done means cross-reference listings, reverse references, and parent values work for the relationships described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100