Skip to content

Commit

Permalink
Update mkdocs configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
zerolab committed Jun 2, 2023
1 parent 2dcb7ca commit 5613915
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
10 changes: 8 additions & 2 deletions docs/stylesheets/mkdocstrings.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
/* Indentation. */
div.doc-contents:not(.first) {
padding-left: 25px;
border-left: 4px solid rgba(230, 230, 230);
margin-bottom: 80px;
border-left: 0.2rem solid var(--md-typeset-table-color);
}

/* Prevent selection of prompt and output from Python console code blocks */
.language-pycon .gp,
.language-pycon .go {
/* Generic.Prompt, Generic.Output */
user-select: none;
}
20 changes: 9 additions & 11 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,26 @@ theme:
- navigation.sections
markdown_extensions:
- admonition
- codehilite
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.superfences:
# Allows us to use mermaid and codehilite together
# https://stackoverflow.com/questions/61638740/exclude-mermaid-code-blocks-for-highlighting-with-codehilite-mkdocs
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.tabbed
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
extra_css:
- stylesheets/mkdocstrings.css
plugins:
- search
- mermaid2:
version: 8.6.4
- autorefs
- mkdocstrings:
handlers:
python:
selection:
filters:
- '!^_' # exlude all members starting with _
- '^__init__$' # but always include __init__ modules and methods
options:
show_root_toc_entry: false
show_signature_annotations: true
setup_commands:
- import os
- import django
Expand Down

0 comments on commit 5613915

Please sign in to comment.