Merge pull request #140 from ekiefl/lower-your-cue

Straight in shot example

Makefile

@@ -1,17 +1,32 @@
-include .env
+# Load environment variables from the `.env` file if it exists.
+ifneq (,$(wildcard .env))
+    include .env
+endif
+
+.PHONY: docs
+docs:
+	$(MAKE) -C docs/ clean-and-build-html
+	$(MAKE) -C docs/ view-html
+
+.PHONY: clean
+clean:
+	rm -rf dist
+
+.PHONY: build
+build: clean
+	poetry build
 
 # Note: `poetry` does not appear to read the `POETRY_PYPI_TOKEN_<NAME>` environment variable,
-# so we need to pass it explicitly in the `publish` command.
-.PHONY: test-publish
-test-publish:
-	echo ${POETRY_PYPI_TOKEN_PYPI_TEST}
+# so we need to pass it explicitly in these publishing commands.
+.PHONY: build-and-test-publish
+build-and-test-publish: build
 	poetry publish \
-		--repository pypi-test \
+		--repository pypi_test \
 		--username __token__ \
 		--password ${POETRY_PYPI_TOKEN_PYPI_TEST}
 
-.PHONY: publish
-publish: build
+.PHONY: build-and-publish
+build-and-publish: build
 	poetry publish \
 		--username __token__ \
 		--password ${POETRY_PYPI_TOKEN_PYPI}

docs/Makefile

@@ -1,18 +1,26 @@
-# Minimal makefile for Sphinx documentation
-#
-
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
 
-# Put it first so that "make" without argument is like "make help".
+# Put `help` first so that calling `make` without argument is like `make help`.
+.PHONY: help
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)
+
+.PHONY: clean-and-build-html
+clean-and-build-html: clean
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: view-html
+view-html:
+	open $(BUILDDIR)/html/index.html
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/README.md

@@ -8,8 +8,8 @@ poetry install --with docs
 
 Additionally, `pandoc` needs to be installed: https://pandoc.org/installing.html
 
-Then navigate to this directory and run:
+Then, in the root directory run:
 
 ```
-bash local.sh
+make docs
 ```

docs/examples/index.md

@@ -3,5 +3,6 @@
 ```{eval-rst}
 .. nbgallery::
    30_degree_rule
+   straight_shot
 ```