Skip to content

Commit d142b54

Browse files
authored
Merge pull request #10322 from FoamyGuy/fix_latex_build
Fix latex docs build
2 parents 9819e7a + 4663b3f commit d142b54

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,22 +156,28 @@ epub:
156156
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
157157

158158
latex:
159+
$(PYTHON) docs/prepare_readme_for_latex.py
159160
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
161+
mv README.rst.bak README.rst
160162
@echo
161163
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
162164
@echo "Run \`make' in that directory to run these through (pdf)latex" \
163165
"(use \`make latexpdf' here to do that automatically)."
164166

165167
# seems to be malfunctioning
166168
latexpdf:
169+
$(PYTHON) docs/prepare_readme_for_latex.py
167170
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
171+
mv README.rst.bak README.rst
168172
@echo "Running LaTeX files through pdflatex..."
169173
$(MAKE) -C $(BUILDDIR)/latex all-pdf
170174
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
171175

172176
# seems to be malfunctioning
173177
latexpdfja:
178+
$(PYTHON) docs/prepare_readme_for_latex.py
174179
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
180+
mv README.rst.bak README.rst
175181
@echo "Running LaTeX files through platex and dvipdfmx..."
176182
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
177183
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

docs/prepare_readme_for_latex.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import shutil
2+
3+
with open("README.rst", "r") as f:
4+
readme_content = f.read()
5+
6+
shutil.copyfile("README.rst", "README.rst.bak")
7+
8+
# turn badge into text only
9+
modified_readme_content = readme_content.replace("|Weblate|", "Weblate", 1)
10+
11+
# remove image link
12+
badge_link_lines = """.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg
13+
:target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget"""
14+
15+
modified_readme_content = modified_readme_content.replace(badge_link_lines, "")
16+
17+
with open("README.rst", "w") as f:
18+
f.write(modified_readme_content)

0 commit comments

Comments
 (0)