Index

_

__call__() (DynamicFunction method) __getitem__() (NeedsView method) __iter__() (NeedsAndPartsListView method) (NeedsView method)

__len__() (NeedsAndPartsListView method) (NeedsView method)

A

add_back_links() (FieldsSchema method) add_backlink() (NeedItem method) add_core_field() (FieldsSchema method) add_dynamic_function() (in module sphinx_needs.api.configuration) add_external_need() (in module sphinx_needs.api.need) add_extra_field() (FieldsSchema method) add_extra_option() (in module sphinx_needs.api.configuration) add_field() (in module sphinx_needs.api.configuration) add_link_field() (FieldsSchema method) add_modification() (NeedItem method)

add_need() (in module sphinx_needs.api.need) add_need_layout() (in module sphinx_needs.api.configuration) add_need_type() (in module sphinx_needs.api.configuration) add_type_overlay() (FieldsSchema method) add_warning() (in module sphinx_needs.api.configuration) admits_null (FieldSchema property) all_passed() (NeedConstraintResults method) allow_dead_links (LinkSchema attribute) AllowedTypes (in module sphinx_needs.needs_schema) arch (NeedsInfoType attribute)

B

back_links() (FieldsSchema method)

BackLinksSchema (class in sphinx_needs.needs_schema)

C

calc_sum() (in module sphinx_needs.functions.common) check_linked_values() (in module sphinx_needs.functions.common) collapse (NeedsInfoType attribute) collapse_button() (in module sphinx_needs.layout.LayoutHandler) color (LinkDisplayConfig attribute) const (FieldBooleanSchemaType attribute) (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute) (FieldStringSchemaType attribute) constraint_results (NeedItem property) constraints (NeedsInfoType attribute) constraints_error (NeedsInfoComputedType attribute) constraints_passed (NeedsInfoComputedType attribute) constraints_results (NeedsInfoComputedType attribute)

contains (FieldMultiValueSchemaType attribute) (LinkSchemaType attribute) content (NeedItem property) (NeedsPartType attribute) convert_directive_option() (FieldSchema method) (LinkSchema method) convert_or_type_check() (FieldSchema method) (LinkSchema method) copy (LinkSchema attribute) copy() (in module sphinx_needs.functions.common) (NeedItem method) (NeedPartItem method) copy_for_needtable() (NeedPartItem method) copying_link_types() (FieldsSchema method) create_need() (in module sphinx_needs.api.need)

D

declared_by (LinkTargetTypes attribute) declares() (TypeFieldsSchema method) declares_default() (FieldsSchema method) declaring_types() (FieldsSchema method) default (FieldSchema attribute) (LinkSchema attribute) DefaultContextData (class in sphinx_needs.api.need) del_need() (in module sphinx_needs.api.need) derive (FieldSchema attribute) (LinkSchema attribute) derive_by_type (FieldSchema attribute) (LinkSchema attribute) DeriveCall (class in sphinx_needs.derive) derived (FieldSchema property) (LinkSchema property)

derived_names (FieldsSchema property) DeriveInvalid (class in sphinx_needs.derive) DeriveJoin (class in sphinx_needs.derive) DeriveRule (class in sphinx_needs.derive) describe() (DeriveCall method) (DeriveInvalid method) (DeriveRule method) describe_derived() (FieldSchema method) (LinkSchema method) dict_repr (NeedItemSourceProtocol property) display (LinkSchema attribute) docname (NeedItemSource property) (NeedsSourceInfoType attribute) document (NeedSourceHop attribute) DynamicFunction (class in sphinx_needs.functions.functions)

E

echo() (in module sphinx_needs.functions.common) end_line (NeedSourcePhysical attribute) enum (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute) (FieldStringSchemaType attribute) exclusiveMaximum (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute)

exclusiveMinimum (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute) external_css (NeedsInfoType attribute) external_url (NeedsSourceInfoType attribute) extras (NeedSourceSemantic attribute)

F

failure_severity (BackLinksSchema property) (FieldSchema property) (LinkSchema property) FieldBooleanSchemaType (class in sphinx_needs.schema.config) FieldFunctionArray (class in sphinx_needs.needs_schema) FieldIntegerSchemaType (class in sphinx_needs.schema.config) FieldLiteralValue (class in sphinx_needs.needs_schema) FieldMultiValueSchemaType (class in sphinx_needs.schema.config) FieldNumberSchemaType (class in sphinx_needs.schema.config) FieldSchema (class in sphinx_needs.needs_schema) FieldShape (class in sphinx_needs.needs_schema) FieldsSchema (class in sphinx_needs.needs_schema) FieldStringSchemaType (class in sphinx_needs.schema.config) filter_context() (NeedItem method) (NeedPartItem method) filter_has_tag() (NeedsAndPartsListView method) (NeedsView method)

filter_id_complete() (NeedsAndPartsListView method) filter_ids() (NeedsAndPartsListView method) (NeedsView method) filter_is_external() (NeedsAndPartsListView method) (NeedsView method) filter_statuses() (NeedsAndPartsListView method) (NeedsView method) filter_types() (NeedsAndPartsListView method) (NeedsView method) first_error() (NeedConstraintResults method) for_type() (FieldsSchema method) format (FieldStringSchemaType attribute) freeze() (FieldsSchema method) from_directive() (NeedItemSource class method) from_string() (NeedLink static method) from_string_with_warnings() (NeedLink static method) frozen (FieldsSchema property) FunctionParsingException

G

generate_need() (in module sphinx_needs.api.need) generate_need_id() (in module sphinx_needs.api.need) get() (NeedItem method) (NeedPartItem method) get_any_field() (FieldsSchema method) (TypeFieldsSchema method) get_backlinks() (NeedItem method) (NeedPartItem method) get_core_field() (FieldsSchema method) (TypeFieldsSchema method) get_extra() (NeedItem method) (NeedPartItem method)

get_extra_field() (FieldsSchema method) (TypeFieldsSchema method) get_link_field() (FieldsSchema method) (TypeFieldsSchema method) get_links() (NeedItem method) (NeedPartItem method) get_need() (NeedsAndPartsListView method) get_need_types() (in module sphinx_needs.api.configuration) get_needs_view() (in module sphinx_needs.api.need) get_part() (NeedItem method) get_part_item() (NeedItem method) global_declaration() (FieldsSchema method)

H

has_dead_links (NeedsInfoType attribute) has_dynamic_fields (NeedItem property)

has_forbidden_dead_links (NeedsInfoType attribute) hide (NeedsInfoType attribute) hops (NeedItemSource attribute)

I

id (NeedItem property) (NeedsInfoType attribute) (NeedsPartType attribute) id_complete (NeedsInfoComputedType attribute) id_parent (NeedsInfoComputedType attribute) id_patterns() (FieldsSchema method) image() (in module sphinx_needs.layout.LayoutHandler) incoming (LinkDisplayConfig attribute) ingest_need_record() (in module sphinx_needs.api.need) InvalidNeedException is_external (NeedsSourceInfoType attribute) is_import (NeedItemSource attribute) (NeedsSourceInfoType attribute) is_in_document() (NeedItem method) (NeedPartItem method) is_modified (NeedsInfoComputedType attribute) is_project_field() (FieldsSchema method) items() (NeedItem method) (NeedPartItem method) iter_all_fields() (FieldsSchema method) (TypeFieldsSchema method)

iter_backlinks_items() (NeedItem method) (NeedPartItem method) iter_core_field_names() (FieldsSchema method) iter_core_fields() (FieldsSchema method) (TypeFieldsSchema method) iter_core_items() (NeedItem method) iter_extra_field_names() (FieldsSchema method) iter_extra_fields() (FieldsSchema method) (TypeFieldsSchema method) iter_extra_items() (NeedItem method) (NeedPartItem method) iter_extra_keys() (NeedItem method) (NeedPartItem method) iter_link_field_names() (FieldsSchema method) iter_link_fields() (FieldsSchema method) (TypeFieldsSchema method) iter_links_items() (NeedItem method) (NeedPartItem method) iter_links_keys() (NeedItem method) (NeedPartItem method) iter_part_items() (NeedItem method)

J

json_schema() (BackLinksSchema method) (FieldSchema method) (LinkSchema method)

K

keys() (NeedItem method) (NeedPartItem method) kind (FieldSchema property) (LinkSchema property) (NeedSourceHop attribute) (NeedSourceSemantic attribute)

L

language (NeedSourceHop attribute) late (DeriveRule property) layout (NeedsInfoType attribute) lineno (NeedItemSource property) (NeedsSourceInfoType attribute) lineno_content (NeedItemSource attribute) (NeedsSourceInfoType attribute) link() (in module sphinx_needs.layout.LayoutHandler) link_type (BackLinksSchema attribute) link_valued (DeriveRule property)

LinkDisplayConfig (class in sphinx_needs.needs_schema) LinkItemSchemaType (class in sphinx_needs.schema.config) links_from_content() (in module sphinx_needs.functions.common) links_from_filter() (in module sphinx_needs.functions.common) links_from_match() (in module sphinx_needs.functions.common) LinkSchema (class in sphinx_needs.needs_schema) LinkSchemaType (class in sphinx_needs.schema.config) LinksFunctionArray (class in sphinx_needs.needs_schema) LinkShape (class in sphinx_needs.needs_schema) LinksLiteralValue (class in sphinx_needs.needs_schema) LinkTargetTypes (class in sphinx_needs.needs_schema)

M

MarkupContent (class in sphinx_needs.api) maxContains (FieldMultiValueSchemaType attribute) (LinkSchemaType attribute) maximum (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute) maxItems (FieldMultiValueSchemaType attribute) (LinkSchemaType attribute) maxLength (FieldStringSchemaType attribute) (LinkItemSchemaType attribute) measure_time() (in module sphinx_needs.debug) meta() (in module sphinx_needs.layout.LayoutHandler) meta_all() (in module sphinx_needs.layout.LayoutHandler) meta_id() (in module sphinx_needs.layout.LayoutHandler) meta_links() (in module sphinx_needs.layout.LayoutHandler) meta_links_all() (in module sphinx_needs.layout.LayoutHandler) minContains (FieldMultiValueSchemaType attribute) (LinkSchemaType attribute) minimum (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute)

minItems (FieldMultiValueSchemaType attribute) (LinkSchemaType attribute) minLength (FieldStringSchemaType attribute) (LinkItemSchemaType attribute) modifications (NeedItem property) (NeedsInfoComputedType attribute) module sphinx_needs.api.configuration sphinx_needs.api.need sphinx_needs.data sphinx_needs.derive sphinx_needs.exceptions sphinx_needs.need_item sphinx_needs.needs_schema sphinx_needs.schema.config sphinx_needs.views multipleOf (FieldIntegerSchemaType attribute) (FieldNumberSchemaType attribute)

N

name (BackLinksSchema attribute) names (LinkTargetTypes attribute) narrowing_problems() (in module sphinx_needs.needs_schema) need_types (FieldsSchema property) NeedConstraintResults (class in sphinx_needs.need_item) NeedItem (class in sphinx_needs.need_item) NeedItemSource (class in sphinx_needs.need_item) NeedItemSourceProtocol (class in sphinx_needs.need_item) NeedLink (class in sphinx_needs.need_item) NeedModification (class in sphinx_needs.need_item) NeedPartData (class in sphinx_needs.need_item) NeedPartItem (class in sphinx_needs.need_item) NeedsAndPartsListView (class in sphinx_needs.views) NeedsApiConfigException NeedsApiConfigWarning

NeedsConfigException NeedsConstraintFailed NeedsContent (class in sphinx_needs.need_item) NeedsInfoComputedType (class in sphinx_needs.data) NeedsInfoType (class in sphinx_needs.data) NeedsInvalidException NeedsInvalidFilter NeedsMutable (class in sphinx_needs.data) NeedSourceHop (class in sphinx_needs.api) NeedSourcePhysical (class in sphinx_needs.api) NeedSourceSemantic (class in sphinx_needs.api) NeedsPartType (class in sphinx_needs.data) NeedsSourceInfoType (class in sphinx_needs.data) NeedsSphinxConfig (class in sphinx_needs.config) NeedsView (class in sphinx_needs.views)

O

off_type_value() (FieldSchema method) (LinkSchema method)

on_page() (NeedItemSource class method) origin (NeedSourceHop attribute) outgoing (LinkDisplayConfig attribute)

P

parent_need (NeedsInfoComputedType attribute) parse_address() (NeedLink static method) parser_lineno (NeedItemSource attribute) part_id (NeedPartItem property) parts (NeedItem property) (NeedsInfoComputedType attribute) path (DeriveRule property) (NeedSourcePhysical attribute)

path_on() (LinkSchema method) pattern (FieldStringSchemaType attribute) (LinkItemSchemaType attribute) permalink() (in module sphinx_needs.layout.LayoutHandler) placement (NeedItemSource property) predicate_defaults (FieldSchema attribute) (LinkSchema attribute) Python Enhancement Proposals PEP 561

R

Reads (class in sphinx_needs.functions.functions) reads() (in module sphinx_needs.api.configuration) RecordReader (in module sphinx_needs.api.need) replace_field() (FieldsSchema method)

reset_backlinks() (NeedItem method) resolve_need_option() (in module sphinx_needs.api.configuration) root (NeedSourcePhysical attribute) rule_for() (FieldSchema method) (LinkSchema method)

S

schema (BackLinksSchema attribute) section_name (NeedsInfoComputedType attribute) semantic (NeedSourceHop attribute) set_constraint_results() (NeedItem method) set_content() (NeedItem method) set_id_patterns() (FieldsSchema method) set_need_types() (FieldsSchema method) set_parts() (NeedItem method) severity (BackLinksSchema attribute) (FieldSchema attribute) (LinkSchema attribute) signature (NeedsInfoType attribute) sort_backlinks() (NeedItem method) sort_links() (NeedItem method) source (NeedItem property) sphinx_needs.api.configuration module sphinx_needs.api.need module sphinx_needs.data module

sphinx_needs.derive module sphinx_needs.exceptions module sphinx_needs.need_item module sphinx_needs.needs_schema module sphinx_needs.schema.config module sphinx_needs.views module start_line (NeedSourcePhysical attribute) style (LinkDisplayConfig attribute) (NeedsInfoType attribute) style_end (LinkDisplayConfig attribute) style_part (LinkDisplayConfig attribute) style_start (LinkDisplayConfig attribute) summary (LinkSchema attribute)

T

target_types (LinkSchema attribute) test() (in module sphinx_needs.functions.common) title (NeedsInfoType attribute) to_dict() (NeedConstraintResults method) to_filter_string() (NeedLink method) to_link_string() (NeedLink method) to_list_with_parts() (NeedsView method) type (FieldBooleanSchemaType attribute) (FieldIntegerSchemaType attribute) (FieldMultiValueSchemaType attribute) (FieldNumberSchemaType attribute) (FieldStringSchemaType attribute) (LinkItemSchemaType attribute) (LinkSchemaType attribute) (NeedsInfoType attribute)

type_check() (FieldSchema method) (LinkSchema method) type_check_item() (FieldSchema method) (LinkSchema method) type_color (NeedsInfoType attribute) type_declarations() (FieldsSchema method) TypeFieldsSchema (class in sphinx_needs.needs_schema) types (LinkTargetTypes attribute)

U

union_on() (LinkSchema method)

uniqueItems (FieldMultiValueSchemaType attribute) url (NeedSourcePhysical attribute)

V

values() (NeedItem method) (NeedPartItem method)

variant_data_proxy (NeedsSphinxConfig attribute) VariantParsingException