Add doc/requirements
We need to specify doc requirements in doc/requirements.txt to avoid problems with the pip resolver [1] for the release team [2][3]. Removing specific doc requirements from test-requirements.txt. The problem here is that this repos haven't doc/requirements.txt file and by default in this case zuul will use the test-requirements.txt file to pull requirements [4]. This requirements file contains extra requirements like flake8 that collided with those allowed in our job environment and so the new pip resolver fails to install these requirements and the job exits in error. This project meet the conditions leading to the bug. [1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html [2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html [3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html [4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36 Change-Id: Ie4cc84c7159f4b59be52439ef6e4c5e60474866d
This commit is contained in:
		 Hervé Beraud
					Hervé Beraud
				
			
				
					committed by
					
						 Xinran Wang
						Xinran Wang
					
				
			
			
				
	
			
			
			 Xinran Wang
						Xinran Wang
					
				
			
						parent
						
							db8479f5c2
						
					
				
				
					commit
					6c93f13c54
				
			
							
								
								
									
										3
									
								
								doc/requirements.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								doc/requirements.txt
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,3 @@ | |||||||
|  | sphinx>=2.0.0,!=2.1.0 # BSD | ||||||
|  | openstackdocstheme>=2.2.1 # Apache-2.0 | ||||||
|  | reno>=3.1.0 # Apache-2.0 | ||||||
| @@ -12,7 +12,7 @@ oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0 | |||||||
| oslo.utils>=3.33.0 # Apache-2.0 | oslo.utils>=3.33.0 # Apache-2.0 | ||||||
| os-client-config>=1.28.0 # Apache-2.0 | os-client-config>=1.28.0 # Apache-2.0 | ||||||
| osc-lib>=1.14.0 # Apache-2.0 | osc-lib>=1.14.0 # Apache-2.0 | ||||||
| PrettyTable<0.8,>=0.7.1 # BSD | PrettyTable>=0.7.1 # BSD | ||||||
| cryptography>=2.7 # BSD/Apache-2.0 | cryptography>=2.7 # BSD/Apache-2.0 | ||||||
| decorator>=3.4.0 # BSD | decorator>=3.4.0 # BSD | ||||||
| openstacksdk>=0.42.0 # Apache-2.0 | openstacksdk>=0.42.0 # Apache-2.0 | ||||||
|   | |||||||
| @@ -6,11 +6,7 @@ hacking>=3.0.1,<3.1.0 # Apache-2.0 | |||||||
|  |  | ||||||
| coverage>=4.0,!=4.4 # Apache-2.0 | coverage>=4.0,!=4.4 # Apache-2.0 | ||||||
| python-subunit>=0.0.18 # Apache-2.0/BSD | python-subunit>=0.0.18 # Apache-2.0/BSD | ||||||
| sphinx>=2.0.0,!=2.1.0 # BSD |  | ||||||
| oslotest>=3.2.0 # Apache-2.0 | oslotest>=3.2.0 # Apache-2.0 | ||||||
| stestr>=2.2.0 # Apache-2.0 | stestr>=2.2.0 # Apache-2.0 | ||||||
| testtools>=2.4.0 # MIT | testtools>=2.4.0 # MIT | ||||||
| openstackdocstheme>=2.2.1 # Apache-2.0 |  | ||||||
| requests-mock>=0.6.0  # Apache-2.0 | requests-mock>=0.6.0  # Apache-2.0 | ||||||
| # releasenotes |  | ||||||
| reno>=3.1.0 # Apache-2.0 |  | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								tox.ini
									
									
									
									
									
								
							
							
						
						
									
										3
									
								
								tox.ini
									
									
									
									
									
								
							| @@ -36,9 +36,12 @@ commands = | |||||||
|     coverage xml -o cover/coverage.xml |     coverage xml -o cover/coverage.xml | ||||||
|  |  | ||||||
| [testenv:docs] | [testenv:docs] | ||||||
|  | deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} | ||||||
|  |        -r{toxinidir}/doc/requirements.txt | ||||||
| commands = sphinx-build -W -b html doc/source doc/build/html | commands = sphinx-build -W -b html doc/source doc/build/html | ||||||
|  |  | ||||||
| [testenv:releasenotes] | [testenv:releasenotes] | ||||||
|  | deps = {[testenv:docs]deps} | ||||||
| commands = | commands = | ||||||
|   sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html |   sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user