Add api docs for the PhaseTransition model (#181)

* add PhaseTransition to model.__all__ * add ScatteringFactor api docs * add Group to models.__all__ and sort alphabetically * add allotrope arg * update module docstring * update module doc * module doc * add module doc * add module doc * add module doc * add module doc * update docs * update vis docs * fix reference
lmmentel · Sep 29, 2024 · d3ba5f2 · d3ba5f2
1 parent 5a48579
commit d3ba5f2
Show file tree

Hide file tree

Showing 22 changed files with 126 additions and 277 deletions.
diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -4,23 +4,40 @@
 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.utils
+
+
+Visualization
+=============
+
+The main entry point for visualizing periodic tables with different
+properties is the :func:`mendeleev.vis.periodictable.periodic_table` function.
+
+.. toctree::
+
    mendeleev.vis.periodictable
    mendeleev.vis.bokeh
    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/mendeleev.vis.bokeh.rst b/docs/source/api/mendeleev.vis.bokeh.rst
@@ -3,27 +3,9 @@ mendeleev.vis.bokeh
 
 .. automodule:: mendeleev.vis.bokeh
 
-
-
-
 
-
-
    .. rubric:: Functions
 
-   .. autosummary::
-
-      periodic_table_bokeh
-
-
-
+   .. autofunction:: periodic_table_bokeh
 
-
-
-
-
-
-
-
-
 
diff --git a/docs/source/api/mendeleev.vis.periodictable.rst b/docs/source/api/mendeleev.vis.periodictable.rst
@@ -1,29 +1,10 @@
-mendeleev.vis.periodictable
+mendeleev.vis.periodictable
 ===========================
 
 .. automodule:: mendeleev.vis.periodictable
 
-
-
-
-
-
-
    .. rubric:: Functions
 
-   .. autosummary::
-
-      periodic_table
-
-
-
-
-
-
-
+   .. autofunction:: periodic_table
 
-
-
-
-
 
diff --git a/docs/source/api/mendeleev.vis.plotly.rst b/docs/source/api/mendeleev.vis.plotly.rst
@@ -3,29 +3,11 @@ mendeleev.vis.plotly
 
 .. automodule:: mendeleev.vis.plotly
 
-
-
-
 
-
-
    .. rubric:: Functions
 
-   .. autosummary::
-
-      create_annotation
-      create_tile
-      periodic_table_plotly
-
-
-
+   .. autofunction:: periodic_table_plotly
 
+   .. autofunction:: create_annotation
 
-
-
-
-
-
-
-
-
+   .. autofunction:: create_tile
diff --git a/docs/source/api/mendeleev.vis.rst b/docs/source/api/mendeleev.vis.rst
diff --git a/docs/source/api/mendeleev.vis.seaborn.rst b/docs/source/api/mendeleev.vis.seaborn.rst
@@ -3,27 +3,9 @@ mendeleev.vis.seaborn
 
 .. automodule:: mendeleev.vis.seaborn
 
-
-
-
 
-
-
    .. rubric:: Functions
 
-   .. autosummary::
-
-      heatmap
-
-
-
-
-
-
-
-
-
-
-
+   .. autofunction:: heatmap
 
 
diff --git a/docs/source/api/mendeleev.vis.utils.rst b/docs/source/api/mendeleev.vis.utils.rst
@@ -3,29 +3,11 @@ mendeleev.vis.utils
 
 .. automodule:: mendeleev.vis.utils
 
-
-
-
 
-
-
    .. rubric:: Functions
 
-   .. autosummary::
-
-      add_tile_coordinates
-      colormap_column
-      create_vis_dataframe
-
-
-
-
-
-
-
-
-
-
-
+   .. autofunction:: add_tile_coordinates
 
+   .. autofunction:: colormap_column
 
+   .. autofunction:: create_vis_dataframe