Skip to content

Commit

Permalink
update vis docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lmmentel committed Sep 29, 2024
1 parent eb6df9c commit 0995c1c
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 140 deletions.
7 changes: 3 additions & 4 deletions docs/source/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,12 @@ Visualization
=============

The main entry point for visualizing periodic tables with different
properties is the :func:`periodictable.periodic_table` function.
properties is the :func:`vis.periodictable.periodic_table` function.

.. autosummary::
:toctree:
.. toctree::

mendeleev.vis.bokeh
mendeleev.vis.periodictable
mendeleev.vis.bokeh
mendeleev.vis.plotly
mendeleev.vis.seaborn
mendeleev.vis.utils
20 changes: 1 addition & 19 deletions docs/source/api/mendeleev.vis.bokeh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,9 @@ mendeleev.vis.bokeh

.. automodule:: mendeleev.vis.bokeh







.. rubric:: Functions

.. autosummary::

periodic_table_bokeh



.. autofunction:: periodic_table_bokeh










23 changes: 2 additions & 21 deletions docs/source/api/mendeleev.vis.periodictable.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,10 @@
mendeleev.vis.periodictable
mendeleev.vis.periodictable
===========================

.. automodule:: mendeleev.vis.periodictable







.. rubric:: Functions

.. autosummary::

periodic_table







.. autofunction:: periodic_table






24 changes: 3 additions & 21 deletions docs/source/api/mendeleev.vis.plotly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
35 changes: 0 additions & 35 deletions docs/source/api/mendeleev.vis.rst

This file was deleted.

20 changes: 1 addition & 19 deletions docs/source/api/mendeleev.vis.seaborn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,9 @@ mendeleev.vis.seaborn

.. automodule:: mendeleev.vis.seaborn







.. rubric:: Functions

.. autosummary::

heatmap











.. autofunction:: heatmap


24 changes: 3 additions & 21 deletions docs/source/api/mendeleev.vis.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 0995c1c

Please sign in to comment.