Skip to content

Commit

Permalink
Cover image
Browse files Browse the repository at this point in the history
  • Loading branch information
sethfischer committed Jun 4, 2021
1 parent 8396be4 commit d9f0b14
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.pio
.venv
.vscode
docs/latex-logo.pdf
4 changes: 4 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: latex-logo
latex-logo:
rsvg-convert --format=pdf --output=latex-logo.pdf _static/images/boards/arduino-uno.svg

# Catch-all target: route all unknown targets to Sphinx
# $(O) is a shortcut for $(SPHINXOPTS)
.PHONY: Makefile
Expand Down
14 changes: 14 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
import sphinx_rtd_theme
import subprocess
import sys


def make_latex_logo():

command = subprocess.run(["make", "latex-logo"], capture_output=True)

sys.stdout.buffer.write(command.stdout)
sys.stderr.buffer.write(command.stderr)


make_latex_logo()

project = "Beginning Arduino with PlatformIO"
copyright = "2021, Seth Fischer"
author = "Seth Fischer"
Expand All @@ -19,3 +31,5 @@

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

latex_logo = "latex-logo.pdf"
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
Beginning Arduino with PlatformIO
=================================

.. only:: not latex

.. image:: _static/images/boards/arduino-uno.svg
:alt: Arduino Uno board


.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down
6 changes: 6 additions & 0 deletions docs/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Trademarks
*PlatformIO* is a trademark of PlatformIO Labs OÜ.


Acknowledgements
----------------

Cover image: Adaptded from PhilippHenkel, CC BY-SA 4.0, via Wikimedia Commons.


.. _`Beginning Arduino with PlatformIO`: https://github.com/sethfischer/arduino-beginner
.. _`Seth Fischer`: https://github.com/sethfischer/
.. _`CC BY-SA 4.0`: https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1

0 comments on commit d9f0b14

Please sign in to comment.