FilesExpand file tree

v3.10.9

/

config.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

262 lines (236 loc) · 8.14 KB

v3.10.9

/

config.yml

Copy path

Top

File metadata and controls

• Code
• Blame

262 lines (236 loc) · 8.14 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

# Circle CI configuration file

# https://circleci.com/docs/

---

version: 2.1

#######################################

# Define some common steps as commands.

#

commands:

check-skip:

steps:

- run:

name: Check-skip

command: |

export git_log=$(git log --max-count=1 --pretty=format:"%B" | tr "\n" " ")

echo "Got commit message:"

echo "${git_log}"

if [[ -v CIRCLE_PULL_REQUEST ]] &&

[[ $git_log =~ (\[skip circle\]|\[circle skip\]|\[skip doc\]|\[doc skip\]) ]]; then

echo "Skip detected, exiting job ${CIRCLE_JOB} for PR ${CIRCLE_PULL_REQUEST}."

circleci-agent step halt;

fi

merge:

steps:

- run:

name: Merge with upstream

command: |

if ! git remote -v | grep upstream; then

git remote add upstream https://github.com/matplotlib/matplotlib.git

fi

git fetch upstream

if [[ "$CIRCLE_BRANCH" != "main" ]] && \

[[ "$CIRCLE_PR_NUMBER" != "" ]]; then

echo "Merging ${CIRCLE_PR_NUMBER}"

git pull --ff-only upstream "refs/pull/${CIRCLE_PR_NUMBER}/merge"

fi

apt-install:

steps:

- run:

name: Install apt packages

command: |

sudo apt-get -qq update

sudo apt-get install -yy --no-install-recommends \

cm-super \

dvipng \

ffmpeg \

fonts-crosextra-carlito \

fonts-freefont-otf \

fonts-noto-cjk \

fonts-wqy-zenhei \

graphviz \

inkscape \

lmodern \

ninja-build \

optipng \

texlive-fonts-recommended \

texlive-latex-base \

texlive-latex-extra \

texlive-latex-recommended \

texlive-pictures \

texlive-xetex

fonts-install:

steps:

- restore_cache:

key: fonts-4

- run:

name: Install custom fonts

command: |

mkdir -p ~/.local/share/fonts

wget -nc \

https://github.com/google/fonts/blob/master/ofl/felipa/Felipa-Regular.ttf?raw=true \

-O ~/.local/share/fonts/Felipa-Regular.ttf || true

wget -nc \

https://github.com/ipython/xkcd-font/blob/master/xkcd-script/font/xkcd-script.ttf?raw=true \

-O ~/.local/share/fonts/xkcd-Script.ttf || true

fc-cache -f -v

- save_cache:

key: fonts-4

paths:

- ~/.local/share/fonts/

pip-install:

description: Upgrade pip and setuptools and wheel to get as clean an install as possible

steps:

- run:

name: Upgrade pip, setuptools, wheel

command: |

python -m pip install --upgrade --user pip

python -m pip install --upgrade --user wheel

python -m pip install --upgrade --user 'setuptools!=60.6.0'

doc-deps-install:

parameters:

numpy_version:

type: string

default: ""

steps:

- run:

name: Install Python dependencies

command: |

python -m pip install --user -r requirements/dev/build-requirements.txt

python -m pip install --user \

numpy<< parameters.numpy_version >> \

-r requirements/doc/doc-requirements.txt

python -m pip install --no-deps --user \

git+https://github.com/matplotlib/mpl-sphinx-theme.git

mpl-install:

steps:

- run:

name: Install Matplotlib

command: |

if [[ "$CIRCLE_BRANCH" == v*-doc ]]; then

# The v*-doc branches must build against the specified release.

version=${CIRCLE_BRANCH%-doc}

version=${version#v}

python -m pip install matplotlib==${version}

else

python -m pip install --user --verbose \

--no-build-isolation --editable .[dev]

fi

- save_cache:

key: build-deps-2

paths:

- subprojects/packagecache

doc-build:

steps:

- restore_cache:

keys:

- sphinx-env-v1-{{ .BuildNum }}-{{ .Environment.CIRCLE_JOB }}

- sphinx-env-v1-{{ .Environment.CIRCLE_PREVIOUS_BUILD_NUM }}-{{ .Environment.CIRCLE_JOB }}

- run:

name: Build documentation

command: |

# Set epoch to date of latest tag.

export SOURCE_DATE_EPOCH="$(git log -1 --format=%at $(git describe --abbrev=0))"

# Set release mode only when deploying to devdocs.

if [ "$CIRCLE_PROJECT_USERNAME" = "matplotlib" ] && \

[ "$CIRCLE_BRANCH" = "main" ] && \

[ "$CIRCLE_PR_NUMBER" = "" ]; then

export RELEASE_TAG='-t release'

fi

mkdir -p logs

make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log"

rm -r build/html/_sources

working_directory: doc

- save_cache:

key: sphinx-env-v1-{{ .BuildNum }}-{{ .Environment.CIRCLE_JOB }}

paths:

- doc/build/doctrees

doc-show-errors-warnings:

steps:

- run:

name: Extract possible build errors and warnings

command: |

(grep "WARNING\|ERROR" /tmp/sphinxerrorswarnings.log ||

echo "No errors or warnings")

# Save logs as an artifact, and convert from absolute paths to

# repository-relative paths.

sed "s~$PWD/~~" /tmp/sphinxerrorswarnings.log > \

doc/logs/sphinx-errors-warnings.log

when: always

- store_artifacts:

path: doc/logs/sphinx-errors-warnings.log

doc-show-deprecations:

steps:

- run:

name: Extract possible deprecation warnings in examples and tutorials

command: |

(grep -rl DeprecationWarning doc/build/html/gallery ||

echo "No deprecation warnings in gallery")

(grep -rl DeprecationWarning doc/build/html/plot_types ||

echo "No deprecation warnings in plot_types")

(grep -rl DeprecationWarning doc/build/html/tutorials ||

echo "No deprecation warnings in tutorials")

# Save deprecations that are from this absolute directory, and

# convert to repository-relative paths.

(grep -Ero --no-filename "$PWD/.+DeprecationWarning.+$" \

doc/build/html/{gallery,plot_types,tutorials} || echo) | \

sed "s~$PWD/~~" > doc/logs/sphinx-deprecations.log

when: always

- store_artifacts:

path: doc/logs/sphinx-deprecations.log

doc-bundle:

steps:

- run:

name: Bundle sphinx-gallery documentation artifacts

command: >

tar cf doc/build/sphinx-gallery-files.tar.gz

doc/api/_as_gen

doc/gallery

doc/plot_types

doc/tutorials

when: always

- store_artifacts:

path: doc/build/sphinx-gallery-files.tar.gz

deploy-docs:

steps:

- run:

name: "Deploy new docs"

command: ./.circleci/deploy-docs.sh

##########################################

# Here is where the real jobs are defined.

#

jobs:

docs-python3:

docker:

- image: cimg/python:3.12

resource_class: large

steps:

- checkout

- check-skip

- merge

- apt-install

- fonts-install

- pip-install

- doc-deps-install

- mpl-install

- doc-build

- doc-show-errors-warnings

- doc-show-deprecations

- doc-bundle

- store_artifacts:

path: doc/build/html

- store_test_results:

path: doc/build/test-results

- add_ssh_keys:

fingerprints:

- "be:c3:c1:d8:fb:a1:0e:37:71:72:d7:a3:40:13:8f:14"

- deploy-docs

#########################################

# Defining workflows gets us parallelism.

#

workflows:

version: 2

build:

jobs:

# NOTE: If you rename this job, then you must update the `if` condition

# and `circleci-jobs` option in `.github/workflows/circleci.yml`.

- docs-python3