update docs

lmmentel · Sep 29, 2024 · eb6df9c · eb6df9c
1 parent 51a5e20
commit eb6df9c
Show file tree

Hide file tree

Showing 9 changed files with 99 additions and 136 deletions.
diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -4,23 +4,41 @@
 API Reference
 *************
 
-Here you'll find API documentation of the mendeleev's modules.
+Here you'll find API documentation of the mendeleev's modules. For most users it'll be enough to use the high-level API provided by the classes below.
+For more advances use cases you can use the lower-level functions and classes across the modules.
 
+.. toctree::
+   :maxdepth: 2
+
+   Models <models>
+
+
+Modules
+=======
 
 .. autosummary::
    :toctree:
 
-   mendeleev.db
    mendeleev.cli
+   mendeleev.db
    mendeleev.econf
    mendeleev.electronegativity
    mendeleev.fetch
    mendeleev.mendeleev
-   mendeleev.models
-   mendeleev.ion
-   mendeleev.vis.periodictable
+   mendeleev.utils
+
+
+Visualization
+=============
+
+The main entry point for visualizing periodic tables with different
+properties is the :func:`periodictable.periodic_table` function.
+
+.. autosummary::
+   :toctree:
+
    mendeleev.vis.bokeh
+   mendeleev.vis.periodictable
    mendeleev.vis.plotly
    mendeleev.vis.seaborn
-   mendeleev.vis.utils
-   mendeleev.utils
+   mendeleev.vis.utils
diff --git a/docs/source/api/electronegativity.rst b/docs/source/api/electronegativity.rst
diff --git a/docs/source/api/mendeleev.cli.rst b/docs/source/api/mendeleev.cli.rst
@@ -1,6 +1,29 @@
 mendeleev.cli
 =============
 
-.. currentmodule:: mendeleev
+.. automodule:: mendeleev.cli
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      clielement
+
+
+
+
+
+
+
+
+
+
+
+
 
-.. autodata:: cli
diff --git a/docs/source/api/mendeleev.ion.rst b/docs/source/api/mendeleev.ion.rst
diff --git a/docs/source/api/mendeleev.models.rst b/docs/source/api/mendeleev.models.rst
diff --git a/docs/source/api/mendeleev.utils.rst b/docs/source/api/mendeleev.utils.rst
@@ -13,8 +13,10 @@
 
    .. autosummary::
 
+      apply_rst_format
       coeffs
       n_effective
+      render_rst_table
 
 
 

diff --git a/docs/source/api/models.rst b/docs/source/api/models.rst
@@ -13,6 +13,27 @@ Element
 .. autoclass:: mendeleev.models.Element
    :members:
 
+.. _econf-class:
+
+ElectronicConfiguration
+-----------------------
+
+.. currentmodule:: mendeleev.econf
+
+.. autoclass:: mendeleev.econf.ElectronicConfiguration
+   :members:
+
+
+.. _group-class:
+
+Group
+-----
+
+.. currentmodule:: mendeleev.models
+
+.. autoclass:: mendeleev.models.Group
+   :members:
+
 
 .. _ion-class:
 
@@ -55,6 +76,27 @@ Isotope
 .. autoclass:: mendeleev.models.Isotope
    :members:
 
+
+.. _oxidationstate-class:
+
+OxidationState
+--------------
+
+.. currentmodule:: mendeleev.models
+
+.. autoclass:: mendeleev.models.OxidationState
+   :members:
+
+.. _scatteringfactor-class:
+
+ScatteringFactor
+----------------
+
+.. currentmodule:: mendeleev.models
+
+.. autoclass:: mendeleev.models.ScatteringFactor
+   :members:
+
 .. _screeningconstant-class:
 
 ScreeningConstant
@@ -75,26 +117,18 @@ Series
 .. autoclass:: mendeleev.models.Series
    :members:
 
-.. _group-class:
-
-Group
------
-
-.. currentmodule:: mendeleev.models
 
-.. autoclass:: mendeleev.models.Group
-   :members:
+.. _phasetransition-class:
 
-.. _oxidationstate-class:
-
-OxidationState
---------------
+PhaseTransition
+---------------
 
 .. currentmodule:: mendeleev.models
 
-.. autoclass:: mendeleev.models.OxidationState
+.. autoclass:: mendeleev.models.PhaseTransition
    :members:
 
+
 .. _propertymetadata-class:
 
 PropertyMetadata
@@ -105,13 +139,3 @@ PropertyMetadata
 .. autoclass:: mendeleev.models.PropertyMetadata
    :members:
 
-.. _econf-class:
-
-ElectronicConfiguration
------------------------
-
-.. currentmodule:: mendeleev.econf
-
-.. autoclass:: mendeleev.econf.ElectronicConfiguration
-   :members:
-
diff --git a/docs/source/api/utils.rst b/docs/source/api/utils.rst
diff --git a/docs/source/api/vis.rst b/docs/source/api/vis.rst