File tree Expand file tree Collapse file tree 4 files changed +107
-1
lines changed Expand file tree Collapse file tree 4 files changed +107
-1
lines changed Original file line number Diff line number Diff line change 1+ {%- if objname.split('.')[-1] == objname %}
2+ {{ objname | escape | underline }}
3+ {%- else %}
4+ {{ objname.split('.')[-1] | escape | underline }}
5+ {%- endif %}
6+
7+ .. currentmodule :: {{ module }}
8+
9+ .. auto{{ objtype }}:: {{ objname }}
Original file line number Diff line number Diff line change 1+ {%- if objname.split('.')[-1] == objname %}
2+ {{ objname | escape | underline }}
3+ {%- else %}
4+ {{ objname.split('.')[-1] | escape | underline }}
5+ {%- endif %}
6+
7+ .. currentmodule :: {{ module }}
8+
9+ .. autoclass :: {{ objname }}
10+
11+ {% block methods %}
12+ .. automethod :: __init__
13+
14+ {% if methods %}
15+ .. rubric :: {{ _('Methods') }}
16+
17+ .. autosummary ::
18+ {% for item in methods %}
19+ ~{{ name }}.{{ item }}
20+ {%- endfor %}
21+ {% endif %}
22+ {% endblock %}
23+
24+ {% block attributes %}
25+ {% if attributes %}
26+ .. rubric :: {{ _('Attributes') }}
27+
28+ .. autosummary ::
29+ {% for item in attributes %}
30+ ~{{ name }}.{{ item }}
31+ {%- endfor %}
32+ {% endif %}
33+ {% endblock %}
Original file line number Diff line number Diff line change 1+ {{ fullname | escape | underline}}
2+
3+ .. automodule :: {{ fullname }}
4+
5+ {% block attributes %}
6+ {%- if attributes %}
7+ .. rubric :: {{ _('Module Attributes') }}
8+
9+ .. autosummary ::
10+ {% for item in attributes %}
11+ {{ item }}
12+ {%- endfor %}
13+ {% endif %}
14+ {%- endblock %}
15+
16+ {%- block functions %}
17+ {%- if functions %}
18+ .. rubric :: {{ _('Functions') }}
19+
20+ .. autosummary ::
21+ {% for item in functions %}
22+ {{ item }}
23+ {%- endfor %}
24+ {% endif %}
25+ {%- endblock %}
26+
27+ {%- block classes %}
28+ {%- if classes %}
29+ .. rubric :: {{ _('Classes') }}
30+
31+ .. autosummary ::
32+ {% for item in classes %}
33+ {{ item }}
34+ {%- endfor %}
35+ {% endif %}
36+ {%- endblock %}
37+
38+ {%- block exceptions %}
39+ {%- if exceptions %}
40+ .. rubric :: {{ _('Exceptions') }}
41+
42+ .. autosummary ::
43+ {% for item in exceptions %}
44+ {{ item }}
45+ {%- endfor %}
46+ {% endif %}
47+ {%- endblock %}
48+
49+ {%- block modules %}
50+ {%- if modules %}
51+ .. rubric :: Modules
52+
53+ .. autosummary ::
54+ :toctree:
55+ :recursive:
56+ {% for item in modules %}
57+ {{ item }}
58+ {%- endfor %}
59+ {% endif %}
60+ {%- endblock %}
Original file line number Diff line number Diff line change 3838## lets us suppress the copy button on select code blocks.
3939copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"
4040
41- templates_path = []
41+ templates_path = ["_templates" ]
4242exclude_patterns = ["_build" , "**.ipynb_checkpoints" ]
4343
4444# This assumes that sphinx-build is called from the root directory
4747html_show_sourcelink = False
4848# Remove namespaces from class/method signatures
4949add_module_names = False
50+ # Hide full module path in navigation
51+ modindex_common_prefix = ["nested_pandas." ]
52+ # Customize display of autosummary entries
53+ autosummary_imported_members = True
5054
5155html_theme = "sphinx_book_theme"
5256
You can’t perform that action at this time.
0 commit comments