fix: fix syntax errors and docs

Author: judithspd

data/process_data.py

@@ -1,4 +1,5 @@
 """Delete the rows of the dataset in which all QIs are set to *."""
+
 import pandas as pd
 
 

data/raw/sav_to_csv.py

@@ -1,4 +1,5 @@
-""""Convert the file StudentsMath_Score.sav into csv."""
+""" "Convert the file StudentsMath_Score.sav into csv."""
+
 import pandas as pd
 
 FILE_NAME = "StudentsMath_Score.sav"

doc/source/conf.py

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "pycanon"
-copyright = "2022, Spanish National Research Council (CSIC)"
+copyright = "2025, Spanish National Research Council (CSIC)"
 author = "Spanish National Research Council (CSIC)"
 
 # The full version, including alpha/beta/rc tags
@@ -56,4 +56,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]

doc/source/index.rst

@@ -1,5 +1,9 @@
-pyCANON: A Python library to check the level of anonymity of a dataset
-======================================================================
+.. image:: https://raw.githubusercontent.com/IFCA-Advanced-Computing/pycanon/main/images/pycanon_logo.png
+   :align: center
+   :width: 400px
+   
+A Python library to check the level of anonymity of a dataset
+================================================================================================
 
 pyCANON is a `Python`_ library which allows the user to know the anonymity
 level of a dataset based on a set of quasi-identifiers (QI), and a set of
@@ -41,3 +45,4 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+

doc/source/intro.rst

@@ -1,7 +1,7 @@
 Getting started
 ###############
 
-Using pyCANON is quite straighforward.
+Start using pyCANON:
 
 Install
 ***********************

doc/source/pycanon.rst

@@ -10,6 +10,14 @@ Subpackages
    pycanon.anonymity
    pycanon.report
    pycanon.utility
+   
+Module contents
+---------------
+
+.. automodule:: pycanon
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Submodules
 ----------
@@ -22,10 +30,3 @@ pycanon.cli module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: pycanon
-   :members:
-   :undoc-members:
-   :show-inheritance:

pycanon/utility/_utility_metrics.py

@@ -94,8 +94,8 @@ def discernability_metric(
     :type data_raw: pandas dataframe
 
     :param data_anon: dataframe with the data anonymized. Assuming that all the
-    equivalence classes have more than k records, and given each suppressed record
-    a penalty of the size of the input dataset.
+        equivalence classes have more than k records, and given each suppressed record
+        a penalty of the size of the input dataset.
     :type data_anon: pandas dataframe
 
     :param quasi_ident: list with the name of the columns of the dataframe