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.

Sign up for GitHub

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

[SYNPY-1423] update mkdocstrings dependency for 1.8.0 #1145

Merged
merged 5 commits into from
Nov 1, 2024
Merged

[SYNPY-1423] update mkdocstrings dependency for 1.8.0 #1145

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ccf0cb7
upgrade to mkdocstring 1.8.0
danlu1 Nov 1, 2024
15d3bb3
convert to use google style docstrings
danlu1 Nov 1, 2024
fc3e84f
remove redundant description
danlu1 Nov 1, 2024
65fad28
reformat
danlu1 Nov 1, 2024
35503fe
remove addition of types in docstrings
danlu1 Nov 1, 2024
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
62 changes: 0 additions & 62 deletions docs/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,3 @@
[data-md-color-scheme="default"] {
--doc-symbol-attribute-fg-color: #953800;
--doc-symbol-function-fg-color: #8250df;
--doc-symbol-method-fg-color: #8250df;
--doc-symbol-class-fg-color: #0550ae;
--doc-symbol-module-fg-color: #5cad0f;

--doc-symbol-attribute-bg-color: #9538001a;
--doc-symbol-function-bg-color: #8250df1a;
--doc-symbol-method-bg-color: #8250df1a;
--doc-symbol-class-bg-color: #0550ae1a;
--doc-symbol-module-bg-color: #5cad0f1a;
}

[data-md-color-scheme="slate"] {
--doc-symbol-attribute-fg-color: #953800;
--doc-symbol-function-fg-color: #8250df;
--doc-symbol-method-fg-color: #8250df;
--doc-symbol-class-fg-color: #0550ae;
--doc-symbol-module-fg-color: #5cad0f;

--doc-symbol-attribute-bg-color: #9538001a;
--doc-symbol-function-bg-color: #8250df1a;
--doc-symbol-method-bg-color: #8250df1a;
--doc-symbol-class-bg-color: #0550ae1a;
--doc-symbol-module-bg-color: #5cad0f1a;
}

/* Indentation. */
div.doc-contents {
padding-left: 25px;
Expand All @@ -35,37 +7,3 @@ div.doc-contents {
.md-typeset table tbody {
font-size: .7rem
}

/* Adds icons in front of `class`, `attribute`, and `function` */
div.doc-class .doc-heading:first-of-type::before {
color: var(--doc-symbol-class-fg-color);
background-color: var(--doc-symbol-class-bg-color);
border-radius: .1rem;
font-size: .85em;
padding: 0 .3em;
font-weight: bold;
content: "class";
margin-right: 5px;
}

div.doc-attribute .doc-heading:first-of-type::before {
color: var(--doc-symbol-attribute-fg-color);
background-color: var(--doc-symbol-attribute-bg-color);
border-radius: .1rem;
font-size: .85em;
padding: 0 .3em;
font-weight: bold;
content: "attr";
margin-right: 5px;
}

div.doc-function .doc-heading:first-of-type::before {
color: var(--doc-symbol-function-fg-color);
background-color: var(--doc-symbol-function-bg-color);
border-radius: .1rem;
font-size: .85em;
padding: 0 .3em;
font-weight: bold;
content: "func";
margin-right: 5px;
}
9 changes: 9 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,24 @@ plugins:
default_handler: python
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://python-markdown.github.io/objects.inv
options:
members_order: source
show_if_no_docstring: False
show_root_heading: True
show_category_heading: True
show_symbol_type_heading: True
show_symbol_type_toc: True
docstring_style: google
docstring_section_style: spacy
filters:
- "!^_"
separate_signature: True
show_signature_annotations: True
signature_crossrefs: True

- autorefs
- termynal:
prompt_literal_start:
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ docs =
mkdocs>=1.5.3
mkdocs-material>=9.4.14
mkdocstrings>=0.24.0
mkdocstrings-python>=1.7.5
mkdocstrings-python>=1.8.0
termynal>=0.11.1
mkdocs-open-in-new-tab~=1.0.3
markdown-include~=0.8.1
Expand Down
Loading
Loading