sphinx-doc/sphinx
GitHub で見るDRY: refactor common functionality in generating index nodes
Open
#2,914 opened on 2016年8月26日
good first issuehelp wantedtype:enhancement
Repository metrics
- Stars
- (5,625 stars)
- PR merge metrics
- (平均マージ 10d 11h) (30d で 11 merged PRs)
説明
I am trying to write a simple extension to automatically add some index nodes. Unfortunately there doesn't seem to be any base function to do that. I found three places where the same essential stuff is being used to add index nodes to the toctree:
- https://github.com/sphinx-doc/sphinx/blob/3639231cec9e3e8e0ec80e38430566527f312fd6/sphinx/domains/std.py#L95
- https://github.com/sphinx-doc/sphinx/blob/84baf05c4f9c3ff3f17779fe522cec7aa444b2f8/sphinx/roles.py#L170
- https://github.com/sphinx-doc/sphinx/blob/84baf05c4f9c3ff3f17779fe522cec7aa444b2f8/sphinx/directives/other.py#L163
So it looks like I have to copy the appropriate implementation pieces of this (add a target node, add an index node, configure each of them).
It would be really useful to refactor the common functionality into a single, simple function that extensions could use.