📝 updating docs template and sphinx

mraniki · Aug 7, 2023 · 3ed9178 · 3ed9178
1 parent d928a7e
commit 3ed9178
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 49 deletions.
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -7,7 +7,7 @@
 */
 
 
-:root {
+/* :root {
   --body-bg: #292929;
   --body-color: #E2E8E4;
   }
@@ -34,6 +34,8 @@
     dt:target, span.highlighted {
 background-color: transparent;
       
-    }
+    } */
 
-
+    .bd-footer {
+      display: none;
+  }
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,36 +1,43 @@
 # Configuration file for the Sphinx documentation builder.
 
+
+# -- Path setup --------------------------------------------------------------
+
 import os
 import sys
+from pathlib import Path
+from typing import Any, Dict
 
-import sphinx_bootstrap_theme
+import pydata_sphinx_theme
+from sphinx.application import Sphinx
 
 sys.path.insert(0, os.path.abspath('../'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'dxsp'
+project = 'findmyorder'
 copyright = '2023, mraniki'
 author = 'mraniki'
-
+language = "en"
 
 # -- General configuration ---------------------------------------------------
 
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',  
+    'sphinx.ext.viewcode',
     "sphinx.ext.intersphinx",
     "hoverxref.extension",
     "sphinx.ext.extlinks",
+    "sphinx_design",
+    "myst_parser",
+    "sphinx_copybutton",
+    "notfound.extension",
+    # "autoapi.extension",
 ]
 
-
-
-# -- Extension configuration ---------------------------------------------------
-
 # -- Extension configuration ---------------------------------------------------
 
 # -- intersphinx ------------
@@ -68,59 +75,91 @@
     'myllm',
 
 ]
-napoleon_google_docstring = True
-autosummary_generate = True
+
+# -- autodoc --------------------
+
 autoclass_content = 'both'
 autodoc_inherit_docstrings = True 
 set_type_checking_flag = True 
 autodoc_member_order = 'bysource'
 add_module_names = True
 
+# -- autoapi -------------------
+
+# autoapi_type = "python"
+# autoapi_dirs = ['../iamlistening']
+# autoapi_keep_files = True
+# autoapi_root = "api"
+# autoapi_member_order = "groupwise"
+
+
+# -- napoleon -------------------
+
+napoleon_google_docstring = True
+
+# -- MyST options -----------------
+
+# This allows us to use ::: to denote directives, useful for admonitions
+myst_enable_extensions = ["colon_fence", "linkify", "substitution"]
+myst_heading_anchors = 2
+myst_substitutions = {"rtd": "[Read the Docs](https://readthedocs.org/)"}
+
 master_doc = 'index'
 source_suffix = ['.rst', '.md']
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+# -- Sitemap ----------------------
+
+# ReadTheDocs has its own way of generating sitemaps, etc.
+if not os.environ.get("READTHEDOCS"):
+    extensions += ["sphinx_sitemap"]
+
+    html_baseurl = os.environ.get("SITEMAP_URL_BASE", "http://127.0.0.1:8000/")
+    sitemap_locales = [None]
+    sitemap_url_scheme = "{link}"
 
-# -- Options for HTML output -------------------------------------------------
 
-html_theme = "bootstrap"
+# -- Options for HTML output --------
 
-html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 html_static_path = ["_static"]
-html_logo = '_static/favicon.png'
+html_css_files = ["custom.css"]
+html_logo = '_static/logo.png'
 html_favicon = '_static/favicon.ico'
-html_css_files = [
-    "custom.css",
-]
 html_show_sphinx = False
+html_show_copyright = False
+html_theme = "pydata_sphinx_theme"
 html_theme_options = {
-    'navbar_title': " ",
-    'navbar_site_name': "Talky",
-    'navbar_sidebarrel': False,
-    'navbar_pagenav': False,
-    'globaltoc_depth': 4,
-    'globaltoc_includehidden': "true",
-    'navbar_class': "navbar",
-    'navbar_fixed_top': "true",
-    'source_link_position': "none",
-
-    'bootswatch_theme': "darkly",
-    'bootstrap_version': "3",
-
-    'navbar_links': [
-        ("TalkyTrader", "https://talkytrader.github.io/wiki/",True),
-        ("_menu",  "➕ More",[
-            ("🆕 What's new?",  "https://github.com/mraniki/tt",True),
-            ("💬 Connect",  "https://talky.rtfd.io",True),
-        ]),
-    ]
+    "secondary_sidebar_items": ["page-toc"],
+    "logo": {
+        "link": "https://talky.readthedocs.io",
+    },
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/mraniki/tt/",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "Telegram",
+            "url": "https://t.me/TTTalkyTraderChat/1",
+            "icon": "fa-brands fa-telegram",
+        },
+        {
+            "name": "Mastodon",
+            "url": "https://mastodon.social/@MrAniki",
+            "icon": "fa-brands fa-mastodon",
+        },
+        {
+            "name": "Tips",
+            "url": "https://coindrop.to/mraniki",
+            "icon": "fa-solid fa-burger",
+        },
+        ],
 
 }
+html_context = {
+   "default_mode": "dark",
 
-
-
-
-def setup(app):
-    app.add_css_file("custom.css")
-
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,32 @@
-.. _findmyorder_index:
-
 ===========
 FindMyOrder
 ===========
 
+.. image:: ../docs/_static/logo-full.png
+  :width: 200
+  :alt: logo
+  :align: right
+
 | Find My order,
 | a parsing package to find trading order
 
 
+User Guide
+==========
+
 .. toctree::
    :maxdepth: 4
-   
+
    01_start
    02_config
+
+
+Module Reference
+================
+
+.. toctree::
+   :maxdepth: 4
+
    03_module