From 45c8fefdc49e7d71be2070bbd88a2a5f88231fea Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Wed, 20 Nov 2019 14:22:07 -0400 Subject: [PATCH] Add sphinx sitemap extension Signed-off-by: Roberto Rosario --- HISTORY.rst | 1 + docs/conf.py | 8 ++++++-- mayan/apps/common/dependencies.py | 5 +++++ requirements/documentation.txt | 1 + 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 3b3cdd82fa..58a592f38a 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -4,6 +4,7 @@ - Update example LDAP authentication settings file. - Update FAQ entry about the LDAP file. - Automate documentation building dependencies. +- Add sphinx sitemap extension. 3.2.10 (2019-11-19) =================== diff --git a/docs/conf.py b/docs/conf.py index 8b7eda9633..fdbce57f67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,8 @@ sys.path.append( # extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # extensions = ["djangodocs", "sphinx.ext.intersphinx"] extensions = [ - 'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag', - 'sphinxcontrib.spelling' + 'sphinx_sitemap', 'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag', + 'sphinxcontrib.spelling', ] blockdiag_antialias = True @@ -264,6 +264,10 @@ extlinks = { ) } +# -- Options for sitemap extension --------------------------------------------- + +html_baseurl = 'https://docs.mayan-edms.com/' + def setup(app): BASE_DIRECTORY = '/opt/' diff --git a/mayan/apps/common/dependencies.py b/mayan/apps/common/dependencies.py index 40bdfeb05d..d261e62d90 100644 --- a/mayan/apps/common/dependencies.py +++ b/mayan/apps/common/dependencies.py @@ -382,6 +382,11 @@ PythonDependency( name='sphinx-autobuild', version_string='==0.7.1' ) +PythonDependency( + environment=environment_documentation, module=__name__, + name='sphinx-sitemap', + version_string='==1.0.2' +) PythonDependency( environment=environment_documentation, module=__name__, name='sphinx_rtd_theme', diff --git a/requirements/documentation.txt b/requirements/documentation.txt index 0d2604016a..ebe46c305c 100644 --- a/requirements/documentation.txt +++ b/requirements/documentation.txt @@ -1,5 +1,6 @@ Sphinx==1.8.5 sphinx-autobuild==0.7.1 +sphinx-sitemap==1.0.2 sphinx_rtd_theme==0.4.3 sphinxcontrib-blockdiag==1.5.5 sphinxcontrib-spelling==4.2.1