Add sphinx sitemap extension

Signed-off-by: Roberto Rosario <roberto.rosario@mayan-edms.com>

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)
 ===================

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/'

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',

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