Merge pull request #1176 from Ouranosinc/doc_references_adjustments

Bibliography and other adjustments
Ouranosinc · Sep 6, 2022 · f218690 · f218690
2 parents caf3a28 + aa982a6
commit f218690
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 16 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -16,7 +16,7 @@ build:
       - pip install llvmlite~=0.38 --ignore-installed
     pre_build:
       - sphinx-apidoc -o docs/ --private --module-first xclim xclim/testing/tests
-      - env SKIPNOTEBOOKS=1 sphinx-build -b linkcheck docs/ _build/linkcheck
+      - env SKIPNOTEBOOKS=1 sphinx-build -b linkcheck docs/ _build/linkcheck || true
 
 conda:
   environment: environment.yml

diff --git a/HISTORY.rst b/HISTORY.rst
@@ -41,6 +41,7 @@ Breaking changes
 * The ``xclim.indices.generic.extreme_temperature_range`` function has been fixed so it now does what its definition says. Results from ``xclim.indicators.cf.etr`` will change. (:issue:`1172`, :pull:`1173`).
 * ``xclim`` now has a dedicated ``indices.fire`` submodule that houses all fire-related indices. The previous ``xclim.indices.fwi`` submodule is deprecated and will be removed in a future version. (:issue:`1152`, :pull:`1159`).
 * The indicator ``xclim.indicators.atmos.fire_weather_indexes`` and indice ``xclim.indices.fire_weather_indexes` have both been deprecated and renamed to ``cffwis_indices``. Calls using the previous naming will be removed in a future version. (:pull:`1159`).
+* `xclim` now explicitly requires `pybtex` in order to generate documentation. (:pull:`1176`).
 
 Bug fixes
 ^^^^^^^^^

diff --git a/docs/conf.py b/docs/conf.py
@@ -273,6 +273,7 @@ class XCStyle(AlphaStyle):
     # Additional stuff for the LaTeX preamble.
     "preamble": r"""
 \renewcommand{\v}[1]{\mathbf{#1}}
+\nocite{*}
 """,
     # Latex figure (float) alignment
     "figure_align": "htbp",

diff --git a/docs/indices.rst b/docs/indices.rst
@@ -46,7 +46,7 @@ Indices related to fire and fire weather. Currently, submodules exist for calcul
    :show-inheritance:
    :noindex:
 
-.. only:: html or text
+.. only:: html
 
     Fire indices footnotes
     ~~~~~~~~~~~~~~~~~~~~~~
@@ -56,31 +56,37 @@ Indices related to fire and fire weather. Currently, submodules exist for calcul
     McArthur Forest Fire Danger Indices methods
     *******************************************
 
-    .. bibliography::
-       :labelprefix: FFDI-
-       :keyprefix: ffdi-
+.. bibliography::
+   :labelprefix: FFDI-
+   :keyprefix: ffdi-
+
+.. only:: html
 
     .. _fwi-footnotes:
 
     Canadian Forest Fire Weather Index System codes
     ***********************************************
 
-    .. bibliography::
-       :labelprefix: CODE-
-       :keyprefix: code-
+.. bibliography::
+   :labelprefix: CODE-
+   :keyprefix: code-
+
+.. only:: html
 
     Matlab code of the GFWED obtained through personal communication.
 
     Fire season determination methods
     *********************************
 
-    .. bibliography::
-       :labelprefix: FIRE-
-       :keyprefix: fire-
+.. bibliography::
+   :labelprefix: FIRE-
+   :keyprefix: fire-
+
+.. only:: html
 
     Drought Code overwintering background
     *************************************
 
-    .. bibliography::
-       :labelprefix: DROUGHT-
-       :keyprefix: drought-
+.. bibliography::
+   :labelprefix: DROUGHT-
+   :keyprefix: drought-
diff --git a/docs/references.rst b/docs/references.rst
@@ -1,4 +1,4 @@
-.. only:: html or text
+.. only:: html
 
     ============
     Bibliography
@@ -7,7 +7,9 @@
     General References
     ------------------
 
-    .. bibliography::
+.. bibliography::
+
+.. only:: html
 
     McArthur Forest Fire Danger System References
     ---------------------------------------------

diff --git a/environment.yml b/environment.yml
@@ -38,6 +38,7 @@ dependencies:
     - netCDF4>=1.4
     - pooch
     - pre_commit
+    - pybtex
     - pydocstyle
     - pylint
     - pytest

diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -10,6 +10,7 @@ mypy
 nbval
 pre-commit>=2.9
 pydocstyle>=5.1.1
+pybtex
 pylint <2.15
 pytest
 pytest-cov
-Original file line number
+Diff line change
@@ Expand Up / @@ -38,6 +38,7 @@ dependencies: @@
         - netCDF4>=1.4
         - pooch
         - pre_commit
+        - pybtex
         - pydocstyle
         - pylint
         - pytest
@@ Expand Down @@