diff --git a/HISTORY.rst b/HISTORY.rst index cd94925127..1330809e56 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -173,6 +173,7 @@ argument: "redis_url". Example: redis://127.0.0.1:6379/0 - Add the setting LOCK_MANAGER_BACKEND_ARGUMENTS. - Automate documentation building dependencies. +- Add sphinx sitemap extension. 3.3.11 (2019-XX-XX) =================== 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 458a9afc0b..3e1b3dd27a 100644 --- a/mayan/apps/common/dependencies.py +++ b/mayan/apps/common/dependencies.py @@ -383,6 +383,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