⚡ Update Sphinx extensions and add toggle button

mraniki · Jul 8, 2023 · 8b795a7 · 8b795a7
1 parent 4628913
commit 8b795a7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,7 @@
     'sphinx_copybutton',
     'myst_parser',
     'sphinxext.remoteliteralinclude',
+    'sphinx_togglebutton',
     # 'sphinx_inline_tabs',
     # 'sphinx_reredirects',
     # 'sphinx_design',

diff --git a/docs/index.rst b/docs/index.rst
@@ -18,16 +18,17 @@ FindMyOrder
 How To Use it
 ==================
 the following example illustrate how to use the module
-
-.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/examples/example.py
-   :language: python
+:class: dropdown
+    .. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/examples/example.py
+    :language: python
 
 
 Settings
 ==================
 Setting available via settings.toml
 
-.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/findmyorder/default_settings.toml
+:class: dropdown
+    .. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/findmyorder/default_settings.toml
     :language: python
 
 FMO class

diff --git a/pyproject.toml b/pyproject.toml
@@ -48,7 +48,7 @@ sphinx-copybutton= "^0.5.2"
 myst-parser = "^2.0.0"
 sphinx-notfound-page = "^0.8.3"
 sphinxext-remoteliteralinclude = "^0.4.0"
-
+sphinx-togglebutton = "*"
 
 [tool.pytest.ini_options]
 pythonpath = "."