Skip to content

implement step 3 of #1434 #1435

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

implement step 3 of #1434 #1435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fc69984
implement step 3 of #1434
PierreEtienneJ Apr 6, 2025
9e7899e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 6, 2025
5035779
fix process_need_outgoing
PierreEtienneJ Apr 6, 2025
7b94470
fix create_back_links
PierreEtienneJ Apr 6, 2025
ff4264e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 6, 2025
0bd3ea7
fix check_links warning when need_id_full is in needs
PierreEtienneJ May 21, 2025
230a4c5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions sphinx_needs/directives/need.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ def check_links(needs: NeedsMutable, config: NeedsSphinxConfig) -> None:
for need_id_full in need_link_value:
need_id_main, need_id_part = split_need_id(need_id_full)

if need_id_main not in needs or (
if (need_id_main not in needs and need_id_full not in needs) or (
need_id_main in needs
and need_id_part
and need_id_part not in needs[need_id_main]["parts"]
Expand Down Expand Up @@ -438,18 +438,22 @@ def create_back_links(needs: NeedsMutable, config: NeedsSphinxConfig) -> None:
for need_id_full in need_link_value:
need_id_main, need_id_part = split_need_id(need_id_full)

if need_id_main in needs:
if key not in needs[need_id_main][option_back]: # type: ignore[literal-required]
needs[need_id_main][option_back].append(key) # type: ignore[literal-required]
if need_id_main in needs or need_id_full in needs:
if need_id_main in needs:
back_need = needs[need_id_main]
else:
back_need = needs[need_id_full]
need_id_part = None

if key not in back_need[option_back]: # type: ignore[literal-required]
back_need[option_back].append(key) # type: ignore[literal-required]

# Handling of links to need_parts inside a need
if need_id_part and need_id_part in needs[need_id_main]["parts"]:
if (
option_back
not in needs[need_id_main]["parts"][need_id_part]
):
needs[need_id_main]["parts"][need_id_part][option_back] = [] # type: ignore[literal-required]
needs[need_id_main]["parts"][need_id_part][option_back].append( # type: ignore[literal-required]
if need_id_part and need_id_part in back_need["parts"]:
if option_back not in back_need["parts"][need_id_part]:
back_need["parts"][need_id_part][option_back] = [] # type: ignore[literal-required]

back_need["parts"][need_id_part][option_back].append( # type: ignore[literal-required]
key
)

Expand Down
19 changes: 14 additions & 5 deletions sphinx_needs/roles/need_outgoing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,22 @@ def process_need_outgoing(
need_id_main, need_id_part = split_need_id(need_id_full)

# If the need target exists, let's create the reference
if (need_id_main in needs_all_needs and not need_id_part) or (
need_id_part
and need_id_main in needs_all_needs
and need_id_part in needs_all_needs[need_id_main]["parts"]
if (
(need_id_main in needs_all_needs and not need_id_part)
or (
need_id_part
and need_id_main in needs_all_needs
and need_id_part in needs_all_needs[need_id_main]["parts"]
)
or (need_id_full in needs_all_needs)
):
try:
target_need = needs_all_needs[need_id_main]
if need_id_main in needs_all_needs:
target_need = needs_all_needs[need_id_main]
else:
target_need = needs_all_needs[need_id_full]
need_id_part = None

if need_id_part and need_id_part in target_need["parts"]:
part_content = target_need["parts"][need_id_part]["content"]
target_title = (
Expand Down
8 changes: 6 additions & 2 deletions sphinx_needs/roles/need_ref.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,12 @@ def process_need_ref(
need_id_full = node_need_ref["reftarget"]
need_id_main, need_id_part = split_need_id(need_id_full)

if need_id_main in all_needs:
target_need = all_needs[need_id_main]
if need_id_main in all_needs or need_id_full in all_needs:
if need_id_main in all_needs:
target_need = all_needs[need_id_main]
else: # ie need_id_full in all_needs
target_need = all_needs[need_id_full]
need_id_part = None

dict_need = transform_need_to_dict(
target_need
Expand Down