Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove docker build targets, dockerfiles and stop doing docker releases #178

Merged
merged 2 commits into from
Aug 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Removed
~~~~~~~

* Development dependency on the deprecated ``sphinx_testing`` package
* Docker containers

Fixed
~~~~~
Expand Down
7 changes: 0 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,6 @@ Alternatively, installation packages are available for:

* `Arch Linux`_

There are also Docker images `jnikula/hawkmoth`_ and
`jnikula/hawkmoth-latexpdf`_ at Docker Hub.

In Sphinx ``conf.py``, add ``hawkmoth`` to ``extensions``, and point
``hawkmoth_root`` at the source tree. See the extension documentation for
details.
Expand All @@ -118,10 +115,6 @@ details.

.. _Arch Linux: https://aur.archlinux.org/packages/?K=hawkmoth

.. _jnikula/hawkmoth-latexpdf: https://hub.docker.com/repository/docker/jnikula/hawkmoth-latexpdf

.. _jnikula/hawkmoth: https://hub.docker.com/repository/docker/jnikula/hawkmoth

Development and Contributing
----------------------------

Expand Down
30 changes: 0 additions & 30 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,36 +79,6 @@ the distro Clang package available to the virtual environment. For example:

python3 -m venv --system-site-packages .venv

Docker
------

To run Sphinx and Hawkmoth using Docker, there are separate images with and
without Latex PDF support, `jnikula/hawkmoth-latexpdf`_ and `jnikula/hawkmoth`_,
respectively. If you don't need Latex PDF support, the latter is much smaller.

The images are based on the official Sphinx Docker images
`sphinxdoc/sphinx-latexpdf`_ and `sphinxdoc/sphinx`_, and can be used
similarly. Just replace the image names.

For example:

.. code-block:: shell

docker run --rm -v /path/to/document:/docs jnikula/hawkmoth make html

To create your own custom images, please have a look at the ``docker`` directory
in the `Hawkmoth source repository`_ for a starting point.

.. _jnikula/hawkmoth-latexpdf: https://hub.docker.com/repository/docker/jnikula/hawkmoth-latexpdf

.. _jnikula/hawkmoth: https://hub.docker.com/repository/docker/jnikula/hawkmoth

.. _sphinxdoc/sphinx-latexpdf: https://hub.docker.com/r/sphinxdoc/sphinx-latexpdf

.. _sphinxdoc/sphinx: https://hub.docker.com/r/sphinxdoc/sphinx

.. _Hawkmoth source repository: https://github.com/jnikula/hawkmoth

Read the Docs
-------------

Expand Down
24 changes: 0 additions & 24 deletions docker/Makefile.local
Original file line number Diff line number Diff line change
Expand Up @@ -27,28 +27,4 @@ docker-test-html: docker-test-build
mkdir -p doc/_build
docker run $(DOCKER_TEST_OUT_MOUNT) $(DOCKER_TEST_TAG) make BUILDDIR=/out html

# Containers for release
DOCKER_MAIN_REPO = jnikula/hawkmoth
DOCKER_LATEXPDF_REPO = jnikula/hawkmoth-latexpdf

.PHONY: docker-build docker-push
docker-build:
docker build --build-arg HAWKMOTH_VERSION=$(HAWKMOTH_VERSION) --file $(docker_dir)/base/Dockerfile --tag $(DOCKER_MAIN_REPO) --tag $(DOCKER_MAIN_REPO):$(HAWKMOTH_VERSION) $(docker_dir)/base

docker-push: docker-build
docker push --all-tags $(DOCKER_MAIN_REPO)

docker-latexpdf-build:
docker build --build-arg HAWKMOTH_VERSION=$(HAWKMOTH_VERSION) --file $(docker_dir)/latexpdf/Dockerfile --tag $(DOCKER_LATEXPDF_REPO) --tag $(DOCKER_LATEXPDF_REPO):$(HAWKMOTH_VERSION) $(docker_dir)/latexpdf

docker-latexpdf-push: docker-latexpdf-build
docker push --all-tags $(DOCKER_LATEXPDF_REPO)

# Build Hawkmoth documentation using the container
docker-html: docker-build
docker run --rm -v $(PWD):/docs $(DOCKER_MAIN_REPO) make html

docker-latexpdf: docker-latexpdf-build
docker run --rm -v $(PWD):/docs $(DOCKER_LATEXPDF_REPO) make latexpdf

CLEAN := $(CLEAN) $(HAWKMOTH_ARCHIVE)
23 changes: 0 additions & 23 deletions docker/base/Dockerfile

This file was deleted.

38 changes: 0 additions & 38 deletions docker/latexpdf/Dockerfile

This file was deleted.

Loading