Skip to content

Added docker image to easier build documentation #110

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Added docker image to easier build documentation #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cca23f
Added docker image to easier build documentation
Nyholm Jul 16, 2016
9d57b7f
Minor fixes
Nyholm Jul 18, 2016
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
18 changes: 18 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
FROM debian:latest

# Credit goes to https://github.com/headstar/sphinx-doc-docker

RUN apt-get update

RUN DEBIAN_FRONTEND=noninteractive apt-get install -y python-pip
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y texlive texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y enchant
RUN apt-get update --fix-missing
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y git

RUN pip install Sphinx==1.4
RUN pip install sphinx_rtd_theme
RUN pip install alabaster
RUN pip install sphinx_bootstrap_theme

CMD ["/bin/bash"]
33 changes: 29 additions & 4 deletions development/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
Building the Documentation
--------------------------
==========================

First `install Sphinx`_ and `install enchant`_ (e.g. ``sudo apt-get install enchant``),
then download the requirements:
We build the documentation with Sphinx. You could install it on your system or use Docker.

Install Sphinx
--------------

Install on local machine
~~~~~~~~~~~~~~~~~~~~~~~~

The installation for Sphinx differs between system. See `Sphinx installation page`_ for details. When Sphinx is
installed you need to `install enchant`_ (e.g. ``sudo apt-get install enchant``).

Using Docker
~~~~~~~~~~~~

If you are using docker. Run the following commands from the repository root.

.. code-block:: bash

$ docker build -t sphinx-doc .
$ docker run -i -t -v /absolute/path/to/repo/root:/doc sphinx-doc
$ # You are now in the docker image
$ cd doc

Build documentation
-------------------

Before we can build the documentation we have to make sure to install all requirements.

.. code-block:: bash

Expand All @@ -15,6 +40,6 @@ To build the docs:
$ make html
$ make spelling

.. _install Sphinx: http://sphinx-doc.org/latest/install.html
.. _Sphinx installation page: http://sphinx-doc.org/latest/install.html
.. _install enchant: http://www.abisource.com/projects/enchant/