Skip to content

Commit

Permalink
Changes needed to be able to use the new Docker images
Browse files Browse the repository at this point in the history
New docker images will use Python3 and a newer Sphinx (1.5.x)
And also a newer Debian
  • Loading branch information
rduivenvoorde committed Jul 18, 2017
1 parent 5f7e4ef commit f60a061
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ notifications:

install:
# Sphinx requirements
- pip install -r REQUIREMENTS.txt
- pip3 install -r REQUIREMENTS.txt
# Latex requirements
# maybe later...

Expand Down
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ BUILDDIR = output
SPHINXOPTS = -D language=$(LANG) -A language=$(LANG) $(SOURCEDIR)
VERSION = testing

# needed for python2 -> python3 migration?
export LC_ALL=C.UTF-8

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
Expand Down Expand Up @@ -80,7 +83,7 @@ localizeresources: clean
fi

html: localizeresources
$(SPHINXINTL) build -l $(LANG) -c $(SOURCEDIR)/conf.py
$(SPHINXINTL) --config $(SOURCEDIR)/conf.py build --language=$(LANG)
# ONLY in the english version run in nit-picky mode, so source errors/warnings will fail in Travis
# -n Run in nit-picky mode. Currently, this generates warnings for all missing references.
# -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1.
Expand Down
2 changes: 1 addition & 1 deletion docker-run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@

cp ~/.transifexrc .
pwd=$(pwd)
docker run -v $pwd:/build -w="/build" --rm=true --name="qgis_docs_master_build" qgis/sphinx_pdf make $@
docker run -v $pwd:/build -w="/build" --rm=true --name="qgis_docs_master_build" qgis/sphinx_pdf_3 make $@
rm -rf .transifexrc
8 changes: 5 additions & 3 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.pngmath']
extensions = ['sphinx.ext.imgmath']


# Add any paths that contain templates here, relative to this directory.
templates_path = ['../themes/qgis-theme']
Expand Down Expand Up @@ -176,7 +177,7 @@
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
html_use_index = False

# If true, the index is split into individual pages for each letter.
#html_split_index = False
Expand Down Expand Up @@ -1240,7 +1241,7 @@
# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
# latex_paper_size = 'a4' # depricated, now in latex_elements

# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
Expand Down Expand Up @@ -1499,3 +1500,4 @@
('py:mod', 'qgis.gui'),
('py:mod', 'qgis.utils'),
]

2 changes: 1 addition & 1 deletion source/docs/training_manual/spatial_databases/geometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For this exercise you should do the following:

Your updated people schema should look something like this:

.. code-block:: sql
.. code-block:: none
\d people
Expand Down
2 changes: 1 addition & 1 deletion source/docs/user_manual/plugins/plugins_oracle_raster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The following is an example using ``gdaladdo``:
This is an example using PL/SQL:

.. code-block:: plpgsql
.. code-block:: none
$ sqlplus scott/tiger
SQL> DECLARE
Expand Down

0 comments on commit f60a061

Please sign in to comment.