Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add signature_name to docstring and all content options section #290

Merged
merged 2 commits into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/get-started/basic-content.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -375,3 +375,22 @@ Note these three important pieces of the page entry:
* `contents:` - lists out the contents of the page.


## All content options

Below is a summary of all the options that can be applied to individual content entries.


```{python}
#| echo: false
#| output: asis

from quartodoc import get_object, MdRenderer, Auto
from quartodoc.builder.utils import extract_type
from griffe.docstrings.dataclasses import DocstringSectionAttributes

renderer = MdRenderer()
choices = get_object("quartodoc.Auto")
res = extract_type(DocstringSectionAttributes, choices.docstring.parsed)[0]

print(renderer.render(res))
```
6 changes: 4 additions & 2 deletions quartodoc/layout.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,12 @@ class Auto(AutoOptions):

Attributes
----------
kind:
name:
Name of the object. This should be the path needed to import it.
signature_name:
Style of name to use in the signature. Can be "relative", "full", or "short".
Relative is whatever was used as the name argument, full is the fully qualified
path the object, and short is the name of the object (i.e. no periods).
members:
A list of members, such as attributes or methods on a class, to document.
include_private:
Expand Down Expand Up @@ -275,7 +278,6 @@ class Auto(AutoOptions):
member_options:
Options to apply to members. These can include any of the options above.


"""

kind: Literal["auto"] = "auto"
Expand Down
Loading