Skip to content

Sphinx Header Parser Module #1

@william-aaron-CFA

Description

@william-aaron-CFA

One of the additions to the MTA python files is a documentation header at the beginning of the file describing the purpose, author, maintainer, and last update of the python code. This adheres to PEP 257 in order to satisfy the requirements for Sphinx documentation generation.

However, this standard competes in form with the PEP 723 standard, and as such the current script_metadata.py module cannot read the Sphinx-oriented metadata. We should not only create a Sphinx-oriented metadata reader for the command line, but have a concrete standard for MTA for determining which information we store in which format.

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions