plot_structure_2d() in site /api docs

.pre-commit-config.yaml

@@ -48,7 +48,7 @@ repos:
         exclude_types: [csv, svg, html, yaml, jupyter]
 
   - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.6.3
+    rev: 1.6.4
     hooks:
       - id: nbqa-ruff
 

assets/make_api_docs.py

@@ -8,6 +8,8 @@
 # - prettier badges linking to source code on GitHub
 # - remove bold tags since they break inline code
 
+ROOT = os.path.dirname(os.path.dirname(__file__))
+os.chdir(ROOT)
 pkg = json.load(open("site/package.json"))
 route = "site/src/routes/api"
 

pymatviz/ptable.py

@@ -456,7 +456,7 @@ def ptable_heatmap_plotly(
             will be bold and 1.5x this size.
         bg_color (str): Plot background color. Defaults to "rgba(0, 0, 0, 0)".
         color_bar (dict[str, Any]): Plotly color bar properties documented at
-            https://plotly.com/python/reference#heatmap-colorbar. Defaults to {}.
+            https://plotly.com/python/reference#heatmap-colorbar. Defaults to `{}`.
         cscale_range (tuple[float | None, float | None]): Color bar range. Defaults to
             (None, None) meaning the range is automatically determined from the data.
         exclude_elements (list[str]): Elements to exclude from the heatmap. E.g. if

pymatviz/structure_viz.py

@@ -100,7 +100,6 @@ def unit_cell_to_lines(cell: Array) -> tuple[Array, Array, Array]:
     return lines, z_indices, unit_cell_lines
 
 
-# TODO rewrite this doc string so that it doesn't mess up the /api page
 def plot_structure_2d(
     struct: Structure,
     ax: plt.Axes = None,
@@ -124,6 +123,7 @@ def plot_structure_2d(
     avoids the conversion hassle of AseAtomsAdaptor.get_atoms(pmg_struct).
 
     For example, these two snippets should give very similar output:
+
     ```py
     from pymatgen.ext.matproj import MPRester
 
@@ -142,6 +142,7 @@ def plot_structure_2d(
     ```
 
     Multiple structures in single figure example:
+
     ```py
     import matplotlib.pyplot as plt
     from pymatgen.ext.matproj import MPRester