Skip to content

Documentation overhaul #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/_templates/autosummary/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{ objname | escape | underline}}

.. currentmodule:: {{ module }}

.. auto{{ objtype }}:: {{ objname }}
30 changes: 30 additions & 0 deletions docs/source/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{{ objname | escape | underline}}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
:members:
:special-members:
:exclude-members: __dict__, __weakref__, __slots__, __init__, __deepcopy__, __hash__

{% block attributes %}
{% if attributes %}
.. rubric:: Attributes
.. autosummary::
:toctree:
{% for item in attributes %}
{{ name }}.{{ item }}
{% endfor %}
{% endif %}
{% endblock %}

{% block methods %}
{% if methods %}
.. rubric:: Methods
.. autosummary::
:toctree:
{% for item in methods %}
{{ name }}.{{ item }}
{% endfor %}
{% endif %}
{% endblock %}
23 changes: 23 additions & 0 deletions docs/source/_templates/autosummary/module.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{{ fullname | escape | underline }}

.. rubric:: Description
.. automodule:: {{ fullname }}
.. currentmodule:: {{ fullname }}

{% if classes %}
.. rubric:: Classes
.. autosummary::
:toctree:
{% for class in classes %}
{{ class }}
{% endfor %}
{% endif %}

{% if functions %}
.. rubric:: Functions
.. autosummary::
:toctree:
{% for function in functions %}
{{ function }}
{% endfor %}
{% endif %}
10 changes: 7 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,11 @@
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
"myst_nb",
]

autodoc_preserve_defaults = True
# autodoc_preserve_defaults = True

myst_enable_extensions = [
"amsmath",
Expand Down Expand Up @@ -197,6 +198,9 @@

# -- Extension configuration -------------------------------------------------
# Autodoc settings
autoclass_content = "class"
# autoclass_content = "both"
autodoc_member_order = "bysource"
autodoc_class_signature = "separated"
autosummary_generate = True
autosummary_generate_overwrite = False
autosummary_ignore_module_all = False
autosummary_imported_members = True
6 changes: 0 additions & 6 deletions docs/source/functionality.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ This is relevant for indexing. In the future we hope to extend support for both.

getting_started.rst

Python API
Python Reference
================

.. toctree::
:maxdepth: 2
:maxdepth: 3

reference.rst

Expand Down
11 changes: 0 additions & 11 deletions docs/source/ktensor.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/pyttb_utils.rst

This file was deleted.

24 changes: 18 additions & 6 deletions docs/source/reference.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
Reference (:mod:`pyttb`)
========================
Reference (:class:`pyttb`)
==========================

.. toctree::
:maxdepth: 2
.. rubric:: Description
.. automodule:: pyttb
.. currentmodule:: pyttb

tensor_classes.rst
algorithms.rst

.. rubric:: Classes
.. autosummary::
:toctree: generated

pyttb.tensor
pyttb.sptensor
pyttb.ktensor
pyttb.ttensor
pyttb.sumtensor
pyttb.tenmat
pyttb.sptenmat
pyttb.pyttb_utils
11 changes: 0 additions & 11 deletions docs/source/sptenmat.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/sptensor.rst

This file was deleted.

12 changes: 0 additions & 12 deletions docs/source/sumtensor.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/source/tenmat.rst

This file was deleted.

22 changes: 0 additions & 22 deletions docs/source/tensor.rst

This file was deleted.

15 changes: 0 additions & 15 deletions docs/source/tensor_classes.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/source/ttensor.rst

This file was deleted.

Loading
Loading