Skip to content

Commit

Permalink
Document style parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Aug 18, 2023
1 parent 23ca1e4 commit 9051201
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion sphinx_pyproject/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ class SphinxConfig(Mapping[str, Any]):
The variables parsed from the ``[tool.sphinx-pyproject]`` table will be added to this namespace.
By default, or if explicitly :py:obj:`None`, this does not happen.
:no-default globalns:
:param style: Either ``pep621`` (default), or ``poetry`` to read configuration from the ``[tool.poetry]`` table.
:no-default style:
.. autosummary-widths:: 1/4
"""
Expand Down Expand Up @@ -332,7 +335,7 @@ def parse_author(config: Dict[str, TOML_TYPES]) -> str:
:param config: The unparsed TOML config for the ``[tool.poetry]`` table.
"""

pep621_style_authors: List[dict[str, str]] = []
pep621_style_authors: List[Dict[str, str]] = []

for author in config["author"]:
match = re.match(r"(?P<name>.*)<(?P<email>.*)>", author)
Expand Down

0 comments on commit 9051201

Please sign in to comment.