add doctest to CI (#259)

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Documentation Build
+
+on: [push, pull_request]
+
+jobs:
+  docbuild:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 100
+
+      - name: Get tags
+        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+
+      - name: Set up minimal Python version
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Setup pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: pip-docs
+          restore-keys: pip-docs
+
+      - name: Install locales
+        run: |
+          sudo apt-get install language-pack-fr
+          sudo localedef -i fr_FR -f UTF-8 fr_FR
+
+      - name: Install dependencies
+        run: |
+          sudo apt install -y pandoc
+          pip install --upgrade pip setuptools wheel
+          pip install -r "requirements_docs.txt"
+          pip install docutils==0.14 commonmark==0.8.1 recommonmark==0.5.0 babel==2.8
+          pip install .
+
+      - name: Build documentation
+        run: sphinx-build -n -j auto -b html -d build/doctrees docs build/html
+
+      - name: Doc Tests
+        run: sphinx-build -a -j auto -b doctest -d build/doctrees docs build/doctest

.readthedocs.yaml

@@ -2,7 +2,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.11"
 sphinx:
   configuration: docs/conf.py
   fail_on_warning: false

docs/index.rst

@@ -68,15 +68,13 @@ Pint-pandas: Unit support for pandas
     User Guide <user/index>
     Advanced topics <advanced/index>
     ecosystem
-    API Reference <api/index>
 
 .. toctree::
     :maxdepth: 1
     :hidden:
     :caption: For developers
 
-    dev/contributing
-    dev/pint-convert
+    dev/contributing <https://github.com/hgrecco/pint-pandas>
 
 .. toctree::
    :maxdepth: 1

docs/user/common.rst

@@ -59,7 +59,8 @@ The default operation of Pandas `pd.concat` function is to perform row-wise conc
 
 .. ipython:: python
     :suppress:
-    :okwarning:
+    :okexcept:
+
         df = pd.concat(list_of_series, axis=1)
 
 

docs/user/reading.rst

@@ -40,7 +40,10 @@ Let's read that into a DataFrame. Here io.StringIO is used in place of reading a
     df = pd.read_csv(io.StringIO(test_data), header=[0, 1], index_col=[0, 1]).T
     # df = pd.read_csv("/path/to/test_data.csv", header=[0, 1])
     for col in df.columns:
-        df[col] = pd.to_numeric(df[col], errors="ignore")
+        try:
+            df[col] = pd.to_numeric(df[col])
+        except ValueError:
+            pass
     df.dtypes
 
 

requirements_docs.txt

@@ -1,4 +1,4 @@
-sphinx>4
+sphinx>=6
 ipython<=8.12
 matplotlib
 mip>=1.13
@@ -16,7 +16,7 @@ dask[complete]
 setuptools>=41.2
 Serialize
 pygments>=2.4
-sphinx-book-theme==0.3.3
+sphinx-book-theme>=1.1.0
 sphinx_copybutton
 sphinx_design
 typing_extensions