matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add sphinx sitemap extension

Browse Source 
Signed-off-by: Roberto Rosario <roberto.rosario@mayan-edms.com>
This commit is contained in:
Roberto Rosario
2019-11-20 14:22:07 -04:00
parent 9205c40e9b
commit 45c8fefdc4
4 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
HISTORY.rst
View File

@@ -4,6 +4,7 @@
- Update example LDAP authentication settings file. - Update example LDAP authentication settings file.
- Update FAQ entry about the LDAP file. - Update FAQ entry about the LDAP file.
- Automate documentation building dependencies. - Automate documentation building dependencies.
- Add sphinx sitemap extension.
3.2.10 (2019-11-19) 3.2.10 (2019-11-19)
=================== ===================

8
docs/conf.py
View File

@@ -44,8 +44,8 @@ sys.path.append(
# extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
# extensions = ["djangodocs", "sphinx.ext.intersphinx"] # extensions = ["djangodocs", "sphinx.ext.intersphinx"]
extensions = [ extensions = [
'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag', 'sphinx_sitemap', 'sphinx.ext.extlinks', 'sphinxcontrib.blockdiag',
'sphinxcontrib.spelling' 'sphinxcontrib.spelling',
] ]
blockdiag_antialias = True blockdiag_antialias = True
@@ -264,6 +264,10 @@ extlinks = {
) )
} }
# -- Options for sitemap extension ---------------------------------------------
html_baseurl = 'https://docs.mayan-edms.com/'
def setup(app): def setup(app):
BASE_DIRECTORY = '/opt/' BASE_DIRECTORY = '/opt/'

5
mayan/apps/common/dependencies.py
View File

@@ -382,6 +382,11 @@ PythonDependency(
name='sphinx-autobuild', name='sphinx-autobuild',
version_string='==0.7.1' version_string='==0.7.1'
) )
PythonDependency(
environment=environment_documentation, module=__name__,
name='sphinx-sitemap',
version_string='==1.0.2'
)
PythonDependency( PythonDependency(
environment=environment_documentation, module=__name__, environment=environment_documentation, module=__name__,
name='sphinx_rtd_theme', name='sphinx_rtd_theme',

1
requirements/documentation.txt
View File

@@ -1,5 +1,6 @@
Sphinx==1.8.5 Sphinx==1.8.5
sphinx-autobuild==0.7.1 sphinx-autobuild==0.7.1
sphinx-sitemap==1.0.2
sphinx_rtd_theme==0.4.3 sphinx_rtd_theme==0.4.3
sphinxcontrib-blockdiag==1.5.5 sphinxcontrib-blockdiag==1.5.5
sphinxcontrib-spelling==4.2.1 sphinxcontrib-spelling==4.2.1