Merge pull request #128 from kayjan/change-docs

kayjan · web-flow · commit 69845775efc5 · 2023-11-28T11:24:09.000+08:00
Change toctree in docs
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -2,19 +2,25 @@
 <html lang="en">
 <head>
     {% block extrahead %}
-        <meta name="description" content="Tree Implementation for Python, integrated with Python list, dictionary, and pandas DataFrame." lang="en" xml:lang="en">
+        <meta name="description" content="Tree Implementation and Methods for Python, integrated with Python list, dictionary, and pandas DataFrame." lang="en" xml:lang="en">
         <meta name="keywords" content="Python, Tree, Bigtree">
         <meta property="og:type" content="website">
         <meta property="og:title" content="Big Tree Documentation">
-        <meta property="og:description" content="Tree Implementation for Python, integrated with Python list, dictionary, and pandas DataFrame.">
+        <meta property="og:description" content="Tree Implementation and Methods for Python, integrated with Python list, dictionary, and pandas DataFrame.">
         <meta property="og:url" content="https://bigtree.readthedocs.io/">
         <meta property="og:image" content="https://i.ibb.co/T1G58Bk/favicon-big.png">
         <meta property="twitter:title" content="Big Tree Documentation">
-        <meta property="twitter:description" content="Tree Implementation for Python, integrated with Python list, dictionary, and pandas DataFrame.">
+        <meta property="twitter:description" content="Tree Implementation and Methods for Python, integrated with Python list, dictionary, and pandas DataFrame.">
         <meta property="twitter:image" content="https://i.ibb.co/T1G58Bk/favicon-big.png">
     {% endblock %}
 </head>
 <body>
+    <div class="sidebar">
+        {% block sidebartoc %}
+        <h3>{{ _('Table Of Contents') }}</h3>
+        {{ toctree(includehidden=True) }}
+        {% endblock %}
+    </div>
     <div class="container">
         {% block content %}
         {{ super() }}
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,4 +1,4 @@
-|:deciduous_tree:| Big Tree Documentation
+|:deciduous_tree:| Documentation
 ============================================
 
 .. image:: https://badge.fury.io/py/bigtree.svg
@@ -29,6 +29,7 @@
 
 .. toctree::
    :maxdepth: 1
+   :hidden:
 
    node
    binarytree
