Merge pull request #83 from Quantmetry/chp_fix_doc_environment

Chp fix doc environment

Author: JulienRoussel77

.github/workflows/test.yml

@@ -41,3 +41,7 @@ jobs:
         run: |
           mypy qolmat
           echo you should uncomment mypy qolmat and delete this line
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

MANIFEST.in

@@ -1,6 +1,6 @@
 .. -*- mode: rst -*-
 
-|GitHubActions|_ |ReadTheDocs|_ |License|_ |PythonVersion|_ |PyPi|_ |Release|_ |Commits|_
+|GitHubActions|_ |ReadTheDocs|_ |License|_ |PythonVersion|_ |PyPi|_ |Release|_ |Commits|_ |Codecov|_
 
 .. |GitHubActions| image:: https://github.com/Quantmetry/qolmat/actions/workflows/test.yml/badge.svg
 .. _GitHubActions: https://github.com/Quantmetry/qolmat/actions
@@ -23,6 +23,9 @@
 .. |Commits| image:: https://img.shields.io/github/commits-since/Quantmetry/qolmat/latest/main
 .. _Commits: https://github.com/Quantmetry/qolmat/commits/main
 
+.. |Codecov| image:: https://codecov.io/gh/quantmetry/qolmat/branch/master/graph/badge.svg
+.. _Codecov: https://codecov.io/gh/quantmetry/qolmat
+
 .. image:: https://raw.githubusercontent.com/Quantmetry/qolmat/main/docs/images/logo.png
     :align: center
 

README.rst

@@ -1,12 +1,14 @@
 name: env_qolmat_doc
 channels:
-    - defaults
     - conda-forge
+    - defaults
 dependencies:
     - numpydoc=1.1.0
     - python=3.8
     - sphinx=4.3.2
     - sphinx-gallery=0.10.1
     - sphinx_rtd_theme=1.0.0
-    - sphinx_markdown_tables==0.0.17
     - typing_extensions=4.0.1
+    - pip
+    - pip:
+      - sphinx-markdown-tables==0.0.17

environment.doc.yml

@@ -11,7 +11,8 @@
 
 from qolmat.benchmark import missing_patterns
 
-SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
+CURRENT_DIR = os.path.abspath(os.path.dirname(__file__))
+ROOT_DIR = os.path.join(CURRENT_DIR, "..")
 
 
 def read_csv_local(data_file_name: str) -> pd.DataFrame:
@@ -27,7 +28,7 @@ def read_csv_local(data_file_name: str) -> pd.DataFrame:
     df : pd.DataFrame
         dataframe
     """
-    df = pd.read_csv(f"{SCRIPT_DIR}/../../data/{data_file_name}.csv")
+    df = pd.read_csv(os.path.join(ROOT_DIR, "data", f"{data_file_name}.csv"))
     return df
 
 

data/beijing.csv renamed to qolmat/data/beijing.csv

@@ -78,6 +78,8 @@
     "Programming Language :: Python :: 3.10",
 ]
 
+PACKAGE_DATA = {"qolmat": ["data/beijing.csv", "data/conductors.csv"]}
+
 setup(
     name=DISTNAME,
     version=VERSION,
@@ -96,4 +98,5 @@
     extras_require=EXTRAS_REQUIRE,
     classifiers=CLASSIFIERS,
     zip_safe=False,
+    package_data=PACKAGE_DATA,
 )