spac_kit.autodocs

The autodocs module provides a Sphinx extension for automatically generating documentation from CCSDS packet definitions.

spac_kit.autodocs

Sphinx extension for automatically generating CCSDS packet documentation.

class spac_kit.autodocs.SpacDocsDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Directive

Sphinx directive for documenting packet definitions.

Generates comprehensive documentation for CCSDS packet structures including field summaries and detailed field descriptions.

ALL_COLUMNS = [('Name', '_name', True), ('DataType', '_data_type', True), ('BitLength', '_bit_length', True), ('BitOffset', '_bit_offset', True), ('ByteOrder', '_byte_order', True), ('FieldType', '_field_type', False), ('ArrayShape', '_array_shape', False), ('ArrayOrder', '_array_order', False)]

has_content = False

May the directive have content?

optional_arguments = 0

Number of optional arguments after the required arguments.

required_arguments = 1

Number of required directive arguments.

run()

Main entry point for the directive.

spac_kit.autodocs.copy_static_css(app, _)

Copy static CSS resources from the extension package to the build directory.

spac_kit.autodocs.generate_packet_stubs(app)

Scan for all _BasePacket instances in a configured module, generate .rst stubs for each, and update a master toctree file.

spac_kit.autodocs.setup(app)

Sphinx extension setup function.

Registers the spacdocs directive, configuration values, and event handlers.