8ab8ac70eb
- Added documentation dependencies to Pipfile:
- Ensures local development environments have access to doc tools for
live previews using sphinx-autobuild.
- Aligns Pipfile with the dependencies required for documentation
builds.
- Avoids relying solely on doc/requirements.txt for managing doc tools.
- Retained doc/requirements.txt for compatibility with Zuul:
- Matches the current state of doc tools in Pipfile.
- Ensures consistency in CI/CD environments where Pipenv is not
always used.
- Provides a stable reference for tox-based execution.
- Referenced OpenStack constraints file to ensure compatibility:
- Ensures that documentation dependencies align with the versions
used in OpenStack CI environments.
- Prevents conflicts between local Pipfile versions and the versions
enforced by OpenStack's upper-constraints.txt.
- Helps maintain stability when running tests and builds in Zuul.
- Explicitly set verify_ssl = true in Pipfile:
- Reinforces SSL verification as a best practice for secure package
installations.
- This setting is already the default in Pipenv, but making it
explicit prevents unintended overrides from environment variables,
global pip configs, or Pipfile.lock changes.
- Ensures consistency across various environments, including CI/CD
pipelines and corporate networks.
- Avoids potential security risks from insecure package sources.
Change-Id: I7144110968395b024cd3962750fc680131de1e5d
Signed-off-by: Andrew Vaillancourt <andrew.vaillancourt@windriver.com>
26 lines
1.0 KiB
Plaintext
26 lines
1.0 KiB
Plaintext
# Documentation and Release Notes Dependencies for Sphinx, Tox, and Zuul CI
|
||
# ------------------------------------------------------------------------
|
||
# This file ensures a consistent environment for building documentation and release notes.
|
||
#
|
||
# Usage:
|
||
# - **Tox (`tox.ini`)** manages documentation builds and release notes.
|
||
# - **Zuul CI** aligns dependencies with OpenStack’s package constraints.
|
||
#
|
||
# Local Development:
|
||
# - **Pipenv** is the preferred tool for local documentation development and previewing.
|
||
# - **sphinx-autobuild** is recommended for live previewing documentation changes.
|
||
# - To maintain consistency, dependencies in **Pipfile should be kept in sync with this file**,
|
||
# as this file is used by Tox and Zuul.
|
||
#
|
||
# If updating dependencies, verify compatibility with OpenStack’s constraints:
|
||
# https://opendev.org/openstack/requirements/src/branch/master/upper-constraints.txt
|
||
|
||
|
||
# Documentation Sphinx
|
||
openstackdocstheme==3.4.1
|
||
sphinx==8.1.3
|
||
sphinx-autobuild==2024.2.4
|
||
|
||
# Documentation Release Notes
|
||
reno==4.1.0
|