From a05ce8b0eb41d41336cbb69cc0b31332e25499c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Fri, 6 Oct 2017 12:02:38 +0200 Subject: [PATCH] Add sphinx.ext.intersphinx to reference other parts of the Nextcloud documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- admin_manual/conf.py | 8 +++++++- developer_manual/conf.py | 8 +++++++- developer_manual/core/theming.rst | 2 +- user_manual/conf.py | 7 ++++++- 4 files changed, 21 insertions(+), 4 deletions(-) diff --git a/admin_manual/conf.py b/admin_manual/conf.py index d6f79f5b1..8bee91dcd 100644 --- a/admin_manual/conf.py +++ b/admin_manual/conf.py @@ -25,7 +25,7 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder'] +extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../_shared_assets/templates'] @@ -282,3 +282,9 @@ epub_copyright = u'2012-2017, The Nextcloud developers' # Include todos? todo_include_todos = True + +# allow to reference other documenation +intersphinx_mapping = { + 'user_manual': ('https://docs.nextcloud.com/server/%s/user_manual/' % (version), '../user_manual/_build/html/com/objects.inv'), + 'developer_manual': ('https://docs.nextcloud.com/server/%s/developer_manual/' % (version), '../developer_manual/_build/html/com/objects.inv'), +} diff --git a/developer_manual/conf.py b/developer_manual/conf.py index 2062e281a..6d1e7218b 100644 --- a/developer_manual/conf.py +++ b/developer_manual/conf.py @@ -25,7 +25,7 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder'] +extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../_shared_assets/templates'] @@ -292,3 +292,9 @@ epub_copyright = u'2012-2017, The Nextcloud developers' # Include todos? todo_include_todos = True + +# allow to reference other documenation +intersphinx_mapping = { + 'admin_manual': ('https://docs.nextcloud.com/server/%s/admin_manual/' % (version), '../admin_manual/_build/html/com/objects.inv'), + 'user_manual': ('https://docs.nextcloud.com/server/%s/user_manual/' % (version), '../user_manual/_build/html/com/objects.inv'), +} diff --git a/developer_manual/core/theming.rst b/developer_manual/core/theming.rst index d96e790a6..4b3b6678c 100644 --- a/developer_manual/core/theming.rst +++ b/developer_manual/core/theming.rst @@ -2,7 +2,7 @@ Theming Nextcloud ================= Themes can be used to customize the look and feel of Nextcloud. -.. note:: This is an advanced way of theming Nextcloud; the Nextcloud team recommends instead the use of the :doc:`../../admin_manual/configuration_server/theming` app which, when enabled, can be accessed from the Admin settings. +.. note:: This is an advanced way of theming Nextcloud; the Nextcloud team recommends instead the use of the :doc:`configuration_server/theming` app which, when enabled, can be accessed from the Admin settings. Getting started =============== diff --git a/user_manual/conf.py b/user_manual/conf.py index 19fc9b6ed..ed9dafdf8 100644 --- a/user_manual/conf.py +++ b/user_manual/conf.py @@ -25,7 +25,7 @@ import sys, os # 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.todo', 'rst2pdf.pdfbuilder'] +extensions = ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../_shared_assets/templates'] @@ -294,3 +294,8 @@ todo_include_todos = True # substitutions go here rst_epilog = '.. |version| replace:: %s' % version + +intersphinx_mapping = { + 'admin_manual': ('https://docs.nextcloud.com/server/%s/admin_manual/' % (version), '../admin_manual/_build/html/com/objects.inv'), + 'developer_manual': ('https://docs.nextcloud.com/server/%s/developer_manual/' % (version), '../developer_manual/_build/html/com/objects.inv'), +}