Skip to content

Commit

Permalink
docs: List griffe-autodocstringstyle extension
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Aug 16, 2024
1 parent 5a24ed8 commit 35058bf
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/extensions/official.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Official extensions are developed and maintained within the mkdocstrings organiz

Available official extensions:

- [`autodocstringstyle`](official/autodocstringstyle.md): Set docstring style to `auto` for external packages. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
- [`inherited-docstrings`](official/inherited-docstrings.md): Inherit docstrings from parent classes.
- [`pydantic`](official/pydantic.md): Support for [Pydantic](https://docs.pydantic.dev/latest/) models. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
- [`sphinx`](official/sphinx.md): Parse [Sphinx](https://www.sphinx-doc.org/)-comments above attributes (`#:`) as docstrings. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/official/autodocstringstyle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `griffe-autodocstringstyle`

[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders }

- **PyPI**: [`griffe-autodocstringstyle`](https://pypi.org/project/griffe-autodocstringstyle/)
- **GitHub**: [mkdocstrings/griffe-autodocstringstyle](https://github.com/mkdocstrings/griffe-autodocstringstyle)
- **Documentation:** [mkdocstrings.github.io/griffe-autodocstringstyle](https://mkdocstrings.github.io/griffe-autodocstringstyle)
- **Extension name:** `griffe_autodocstringstyle`

---

This extension sets the docstring parser to `auto` for all the docstrings of external packages. Packages are considered "external" when their sources are found in a virtual environment instead of a folder under the current working directory. Setting their docstring style to `auto` is useful if you plan on rendering the docstring of these objects in your own documentation.

1 change: 1 addition & 0 deletions docs/insiders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ a handful of them, [thanks to our awesome sponsors][sponsors]!
data_source = [
"docs/insiders/goals.yml",
("mkdocstrings/griffe2md", "https://mkdocstrings.github.io/griffe2md/", "insiders/goals.yml"),
("mkdocstrings/griffe-autodocstringstyle", "https://mkdocstrings.github.io/griffe-autodocstringstyle/", "insiders/goals.yml"),
("mkdocstrings/griffe-inherited-docstrings", "https://mkdocstrings.github.io/griffe-inherited-docstrings/", "insiders/goals.yml"),
("mkdocstrings/griffe-pydantic", "https://mkdocstrings.github.io/griffe-pydantic/", "insiders/goals.yml"),
("mkdocstrings/griffe-sphinx", "https://mkdocstrings.github.io/griffe-sphinx/", "insiders/goals.yml"),
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ nav:
- dataclasses: extensions/built-in/dataclasses.md
- Official:
- extensions/official.md
- autodocstringstyle: extensions/official/autodocstringstyle.md
- inherited-docstrings: extensions/official/inherited-docstrings.md
- pydantic: extensions/official/pydantic.md
- sphinx: extensions/official/sphinx.md
Expand Down

0 comments on commit 35058bf

Please sign in to comment.