Bring pypandoc_binary back on linux to work around old version in ubuntu

aai-institute · Sep 17, 2023 · 0ebb0bf · 0ebb0bf
1 parent 2ceca16
commit 0ebb0bf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -35,15 +35,15 @@ library. E.g. with venv:
 ```shell script
 python -m venv ./venv
 . venv/bin/activate  # `venv\Scripts\activate` in windows
-pip install -r requirements-dev.txt
+pip install -r requirements-dev.txt -r requirements-docs.txt
 ```
 
 With conda:
 
 ```shell script
 conda create -n pydvl python=3.8
 conda activate pydvl
-pip install -r requirements-dev.txt
+pip install -r requirements-dev.txt -r requirements-docs.txt
 ```
 
 A very convenient way of working with your library during development is to
@@ -54,11 +54,12 @@ pip install -e .
 ```
 
 In order to build the documentation locally (which is done as part of the tox
-suite) you will need [pandoc](https://pandoc.org/). Under Ubuntu it can be
-installed with:
+suite) [pandoc](https://pandoc.org/) is required. Except for OSX, it should be installed
+automatically as a dependency with `requirements-docs.txt`. Under OSX you can
+install pandoc (you'll need at least version 2.11) with:
 
 ```shell script
-sudo apt-get update -yq && apt-get install -yq pandoc
+brew install pandoc
 ```
 
 Remember to mark all autogenerated directories as excluded in your IDE. In

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -15,5 +15,6 @@ mkdocs-material
 mkdocs-section-index
 mkdocs-macros-plugin
 neoteroi-mkdocs  # Needed for card grid on home page
-pypandoc
+pypandoc; sys_platform == 'darwin'
+pypandoc_binary; sys_platform != 'darwin'
 GitPython