Skip to content

Commit

Permalink
docs: remove docker documentation
Browse files Browse the repository at this point in the history
Stop doing release docker images. Nobody seems to need them.
  • Loading branch information
jnikula committed Aug 13, 2023
1 parent d8f5301 commit ec0aafa
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 37 deletions.
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

0 comments on commit ec0aafa

Please sign in to comment.