Reorganize navtree

kolonialno · Dec 20, 2022 · ca59b0a · ca59b0a
1 parent bc52d3e
commit ca59b0a
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 42 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -126,3 +126,9 @@ h1 {
 .wy-side-nav-search a:visited {
   color: white !important;
 }
+
+/* Decrease the vertical padding between menu items in the navbar */
+.wy-menu-vertical li.toctree-l3 a {
+  padding-top: 0.2vh !important;
+  padding-bottom: 0.2vh !important;
+}
diff --git a/docs/api/patito/DataFrame/index.rst b/docs/api/patito/DataFrame/index.rst
@@ -5,10 +5,8 @@
 
 .. autoclass:: DataFrame
 
-Methods
--------
-
 .. toctree::
+   :caption: Methods
    :maxdepth: 1
 
    cast <cast>

diff --git a/docs/api/patito/Database/index.rst b/docs/api/patito/Database/index.rst
@@ -7,10 +7,8 @@ patito.Database
 
 .. automethod:: Database.__init__
 
-Methods
--------
-
 .. toctree::
+   :caption: Methods
    :maxdepth: 1
 
    create_enum_types <create_enum_types>

diff --git a/docs/api/patito/Model/index.rst b/docs/api/patito/Model/index.rst
@@ -7,40 +7,31 @@ patito.Model
 
 .. autoclass:: Model
 
-Class properties
-----------------
-
 .. toctree::
+   :caption: Class methods & properties
    :maxdepth: 1
 
    DataFrame <DataFrame>
    LazyFrame <LazyFrame>
    columns <columns>
    defaults <defaults>
-   dtypes <dtypes>
-   non_nullable_columns <non_nullable_columns>
-   nullable_columns <nullable_columns>
-   sql_types <sql_types>
-   unique_columns <unique_columns>
-   valid_dtypes <valid_dtypes>
-   valid_sql_types <valid_sql_types>
-
-Class methods
--------------
-
-.. toctree::
-   :maxdepth: 1
-
    drop <drop>
+   dtypes <dtypes>
    example <example>
    example_value <example_value>
    examples <examples>
    from_row <from_row>
    join <join>
+   non_nullable_columns <non_nullable_columns>
+   nullable_columns <nullable_columns>
    pandas_examples <pandas_examples>
    prefix <prefix>
    rename <rename>
    select <select>
+   sql_types <sql_types>
    suffix <suffix>
+   unique_columns <unique_columns>
+   valid_dtypes <valid_dtypes>
+   valid_sql_types <valid_sql_types>
    validate <validate>
    with_fields <with_fields>
diff --git a/docs/api/patito/Relation/index.rst b/docs/api/patito/Relation/index.rst
@@ -7,30 +7,19 @@ patito.Relation
 
 .. automethod:: Relation.__init__
 
-Properties
-----------
-
-.. toctree::
-   :maxdepth: 1
-
-   alias <alias>
-   columns <columns>
-   model <model>
-   types <types>
-
-Methods
--------
-
 .. toctree::
+   :caption: Methods & Properties
    :maxdepth: 1
 
    add_prefix <add_prefix>
    add_suffix <add_suffix>
    aggregate <aggregate>
+   alias <alias>
    all <all>
    case <case>
    cast <cast>
    coalesce <coalesce>
+   columns <columns>
    count <count>
    create_table <create_table>
    create_view <create_view>
@@ -46,14 +35,16 @@ Methods
    join <join>
    left_join <left_join>
    limit <limit>
+   model <model>
    order <order>
-   select <select>
    rename <rename>
+   select <select>
    set_alias <set_alias>
    set_model <set_model>
    to_df <to_df>
    to_pandas <to_pandas>
    to_series <to_series>
+   types <types>
    union <union>
    with_columns <with_columns>
    with_missing_defaultable_columns <with_missing_defaultable_columns>

diff --git a/docs/api/patito/sources/QuerySource/index.rst b/docs/api/patito/sources/QuerySource/index.rst
@@ -5,10 +5,8 @@ patito.sources.QuerySource
 
 .. autoclass:: QuerySource
 
-Methods
--------
-
 .. toctree::
+   :caption: Methods
    :maxdepth: 1
 
    as_query <as_query>

diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 # Allow the TOC tree to be expanded three levels
 html_theme_options = {
     "collapse_navigation": False,
-    "navigation_depth": 4,
+    "navigation_depth": 5,
 }
 
 # These folders are copied to the documentation's HTML output

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,6 +3,7 @@ Overview
 
 .. toctree::
    :hidden:
+   :titlesonly:
 
    Tutorials - User Guide <tutorial/index>
    api/index