Skip to content

Commit

Permalink
Remove intersphinx and enable Strict mode
Browse files Browse the repository at this point in the history
Intersphinx was preventing the strict mode from being enabled
due to docs being built in a network isolated mock environment.

Intersphinx was also going to break because it is tied
to URLs from ReadTheDocs. Now intersphinx is removed, and
usage of it was dropped from the content. Strict Sphinx
mode is now enabled.

https://pulp.plan.io/issues/2034
re #2034
  • Loading branch information
Brian Bouterse committed Jun 24, 2016
1 parent b7618ab commit 9fe2730
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -W -n
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
Expand Down
5 changes: 1 addition & 4 deletions docs/conf.py
Expand Up @@ -30,7 +30,7 @@

# 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.intersphinx', 'sphinx.ext.extlinks']
extensions = ['sphinx.ext.extlinks']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -246,9 +246,6 @@
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

intersphinx_mapping = {'python': ('http://docs.python.org/2.7/', None),
'platform': (("http://pulp.readthedocs.org/en/%s/" % rtd_builder), None)}

extlinks = {'redmine': ('https://pulp.plan.io/issues/%s', '#'),
'fixedbugs': ('https://pulp.plan.io/projects/pulp_rpm/issues?c%%5B%%5D=tracker&c%%5B'
'%%5D=status&c%%5B%%5D=priority&c%%5B%%5D=cf_5&c%%5B%%5D=subject&c%%5B'
Expand Down
11 changes: 5 additions & 6 deletions docs/user-guide/installation.rst
Expand Up @@ -2,17 +2,16 @@ Installation
============

.. note::
If you followed the Pulp :ref:`installation <platform:server_installation>`
instructions you already have RPM features installed. If not, this document
will walk you through the installation.
If you followed the Pulp installation instructions you already have RPM
features installed. If not, this document will walk you through the installation.

Prerequisites
-------------

The only requirement is to meet the prerequisites of the Pulp Platform. Please
see the :ref:`Pulp Installation Guide <platform:server_installation>` for
prerequisites including repository setup. Also reference that document to learn
more about what each of the following components are for.
see the Pulp Installation Guide for prerequisites including repository setup.
Also reference that document to learn more about what each of the following
components are for.

Server
------
Expand Down

0 comments on commit 9fe2730

Please sign in to comment.