Merge branch 'master' into fix-mkdocs-warnings

dynaconf · Feb 26, 2024 · a8ae36f · a8ae36f
2 parents 0d9ba54 + 6daf249
commit a8ae36f
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,4 @@
+# dyanconf API
+
+::: dynaconf
+
diff --git a/docs/stylesheets/mkdocstrings.css b/docs/stylesheets/mkdocstrings.css
@@ -0,0 +1,27 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+    padding-left: 25px;
+    border-left: .05rem solid var(--md-typeset-table-color);
+  }
+
+  /* Mark external links as such. */
+  a.external::after,
+  a.autorefs-external::after {
+    /* https://primer.style/octicons/arrow-up-right-24 */
+    mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+    -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+    content: ' ';
+
+    display: inline-block;
+    vertical-align: middle;
+    position: relative;
+
+    height: 1em;
+    width: 1em;
+    background-color: var(--md-typeset-a-color);
+  }
+
+  a.external:hover::after,
+  a.autorefs-external:hover::after {
+    background-color: var(--md-accent-fg-color);
+  }
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,6 +19,8 @@ nav:
   - Django: django.md
   - Advanced usage: advanced.md
   - FAQ: faq.md
+  - Reference:
+    - API: api.md
 theme:
   features:
     - search.suggest
@@ -68,6 +70,14 @@ plugins:
   - git-revision-date
   - search:
       lang: en
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            show_root_toc_entry: false
+            show_object_full_path: true
 extra:
   disqus: dynaconf
   social:
@@ -79,3 +89,5 @@ extra:
       link: https://linkedin.com/in/rochacbruno
     - icon: fontawesome/brands/twitch
       link: https://twitch.tv/codeshow
+extra_css:
+  - stylesheets/mkdocstrings.css
diff --git a/requirements.txt b/requirements.txt
@@ -7,6 +7,7 @@
 # mkdocs-material-extensions
 
 mkdocs
+mkdocstrings[python]
 pymdown-extensions
 mkdocs-material
 mkdocs-git-revision-date-plugin

diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -37,6 +37,7 @@ pdbr[ipython]
 
 # MKDOCS
 mkdocs>=1.1.2
+mkdocstrings[python]
 mkdocs-material>=5.3.2
 mkdocs-material-extensions>=1.0
 mkdocs-git-revision-date-plugin