Skip to content

fix(add_docs): populate the full key on options #99

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
oraNod wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(add_docs): populate the full key on options #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions collection_prep/cmd/add_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# PYTHON_ARGCOMPLETE_OK

"""Generate or update collection documentation."""

import ast
import logging
import os
Expand Down Expand Up @@ -95,6 +96,23 @@ def convert_descriptions(data):
convert_descriptions(definition["contains"])


def add_full_key(options, parent_key=None):
"""Walk the options/return tree and set full_key on each entry.

full_key is a list of key names from root to leaf, used by the
RST template to build unique HTML anchor IDs.
"""
if not options:
return
for key, value in options.items():
full_key = (parent_key or []) + [key]
value["full_key"] = full_key
if "suboptions" in value:
add_full_key(value["suboptions"], full_key)
if "contains" in value:
add_full_key(value["contains"], full_key)


def jinja_environment():
"""Define the jinja environment.

Expand Down Expand Up @@ -328,6 +346,7 @@ def process(collection: str, path: Path): # pylint: disable-msg=too-many-locals
else:
doc["return_docs"] = yaml.safe_load(return_docs)
convert_descriptions(doc["return_docs"])
add_full_key(doc["return_docs"])

doc["metadata"] = (metadata,)
if isinstance(examples, string_types):
Expand All @@ -342,6 +361,7 @@ def process(collection: str, path: Path): # pylint: disable-msg=too-many-locals
doc["description"] = ensure_list(doc["description"])
try:
convert_descriptions(doc["options"])
add_full_key(doc["options"])
except KeyError:
pass # This module takes no options

Expand Down