Automate documentation building dependencies

Signed-off-by: Roberto Rosario <roberto.rosario@mayan-edms.com>
This commit is contained in:
Roberto Rosario
2019-11-20 14:08:00 -04:00
parent 448176111b
commit 3bb07d6dcf
5 changed files with 49 additions and 6 deletions

View File

@@ -172,6 +172,7 @@
- Add Redis based distributed lock backend. Requires one
argument: "redis_url". Example: redis://127.0.0.1:6379/0
- Add the setting LOCK_MANAGER_BACKEND_ARGUMENTS.
- Automate documentation building dependencies.
3.3.11 (2019-XX-XX)
===================

View File

@@ -241,6 +241,7 @@ generate-setup: generate-requirements
generate-requirements: ## Generate all requirements files from the project depedency declarations.
@./manage.py generaterequirements build > requirements/build.txt
@./manage.py generaterequirements development > requirements/development.txt
@./manage.py generaterequirements documentation > requirements/documentation.txt
@./manage.py generaterequirements testing > requirements/testing-base.txt
@./manage.py generaterequirements production --exclude=django > requirements/base.txt
@./manage.py generaterequirements production --only=django > requirements/common.txt

View File

@@ -3,8 +3,8 @@ from __future__ import absolute_import, unicode_literals
from django.utils.translation import ugettext_lazy as _
from mayan.apps.dependencies.classes import (
environment_build, environment_development, environment_testing,
PythonDependency
environment_build, environment_development, environment_documentation,
environment_testing, PythonDependency
)
PythonDependency(
@@ -286,6 +286,8 @@ PythonDependency(
module=__name__, name='whitenoise', version_string='==4.1.4'
)
# Development
PythonDependency(
module=__name__, environment=environment_development, name='Werkzeug',
version_string='==0.15.4'
@@ -331,6 +333,8 @@ PythonDependency(
module=__name__, name='transifex-client', version_string='==0.13.6'
)
# Testing
PythonDependency(
environment=environment_testing, module=__name__, name='codecov',
version_string='==2.0.15'
@@ -357,6 +361,8 @@ PythonDependency(
version_string='==5.6.3'
)
# Build
PythonDependency(
environment=environment_build, module=__name__, name='twine',
version_string='==1.9.1'
@@ -365,3 +371,36 @@ PythonDependency(
environment=environment_build, module=__name__, name='wheel',
version_string='==0.30.0'
)
# Documentation
PythonDependency(
environment=environment_documentation, module=__name__, name='Sphinx',
version_string='==1.8.5'
)
PythonDependency(
environment=environment_documentation, module=__name__,
name='sphinx-autobuild',
version_string='==0.7.1'
)
PythonDependency(
environment=environment_documentation, module=__name__,
name='sphinx_rtd_theme',
version_string='==0.4.3'
)
PythonDependency(
environment=environment_documentation, module=__name__,
name='sphinxcontrib-blockdiag',
version_string='==1.5.5'
)
PythonDependency(
environment=environment_documentation, module=__name__,
name='sphinxcontrib-spelling',
version_string='==4.2.1'
)
# sphinx-autobuild has a dependency on Tornado,
# but Tornado 6.0 dropped support for Python 2.7
PythonDependency(
environment=environment_documentation, module=__name__, name='tornado',
version_string='<6.0'
)

View File

@@ -77,6 +77,12 @@ environment_development = DependencyEnvironment(
'can ignore missing dependencies under this environment.'
), label=_('Development'), name='development'
)
environment_documentation = DependencyEnvironment(
help_text=_(
'Environment used for building the documentation. End users '
'can ignore missing dependencies under this environment.'
), label=_('Documentation'), name='documentation'
)
environment_production = DependencyEnvironment(
help_text=_(
'Normal environment for end users. A missing dependency under this '

View File

@@ -1,10 +1,6 @@
Sphinx==1.8.5
sphinx-autobuild==0.7.1
sphinx_rtd_theme==0.4.3
sphinxcontrib-blockdiag==1.5.5
sphinxcontrib-spelling==4.2.1
# sphinx-autobuild has a dependency on Tornado,
# but Tornado 6.0 dropped support for Python 2.7
tornado<6.0