Tweak doc (#308)

facebookresearch · Jan 8, 2025 · 2202a2e · 2202a2e
1 parent 521c88b
commit 2202a2e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -8,7 +8,7 @@
 
 /*
  */
-div.custom_autosummary h2 {
+div.custom_autosummary h3 {
    color: #c95362;
    display: none;
    height: 0;

diff --git a/docs/source/_templates/_custom_autosummary_module.rst b/docs/source/_templates/_custom_autosummary_module.rst
@@ -20,8 +20,14 @@
 
 {{ fullname | escape | underline }}
 
+Overview
+--------
+
 .. automodule:: {{ fullname }}
 
+API Reference
+-------------
+
 ..
    ############################################################################
    Functions
@@ -32,7 +38,7 @@
 .. rubric:: {{ _('Functions') }}
 
 {% for item in functions %}
-{{ item | escape | underline(line='-')}}
+{{ item | escape | underline(line='^')}}
 .. autosummary::
    :toctree:
    :nosignatures:
@@ -54,7 +60,7 @@
 .. rubric:: {{ _('Module Attributes') }}
 
 {% for item in attributes %}
-{{ item | escape | underline(line='-')}}
+{{ item | escape | underline(line='^')}}
 .. autosummary::
    :toctree:
    :nosignatures:
@@ -76,7 +82,7 @@
 .. rubric:: {{ _('Classes') }}
 
 {% for item in classes %}
-{{ item | escape | underline(line='-')}}
+{{ item | escape | underline(line='^')}}
 .. autosummary::
    :toctree:
    :nosignatures:
@@ -99,7 +105,7 @@
 .. rubric:: {{ _('Exceptions') }}
 
 {% for item in exceptions %}
-{{ item | escape | underline(line='-')}}
+{{ item | escape | underline(line='^')}}
 .. autosummary::
    :toctree:
    :nosignatures:
@@ -121,7 +127,7 @@
 .. rubric:: Modules
 
 {% for item in modules %}
-{{ item | escape | underline(line='-')}}
+{{ item | escape | underline(line='^')}}
 .. autosummary::
    :toctree:
    :hide_from_toctree:
@@ -151,7 +157,7 @@
 .. rubric:: Others
 
 {%- for item in others %}
-{{ item | escape | underline(line='-')}}
+{{ item | escape | underline(line='^')}}
 
 .. autosummary::
    :template: _custom_autosummary_others.rst