Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Change location for docs/requirements.txt #4932

Conversation

carlbuchmann
Copy link
Member

Change Summary

  • Update docs/requirements.txt path
  • cut ansible_collections/arista/avd/docs/requirements.txt
  • Requires aristanetworks/avd-docs#11 to be merged

Related Issue(s)

Fixes #4931

Component(s) name

Documentation requirements

@carlbuchmann carlbuchmann requested review from a team as code owners January 24, 2025 18:51
Copy link

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4932
# Activate the virtual environment
source test-avd-pr-4932/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/carlbuchmann/[email protected]#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/carlbuchmann/avd.git#/ansible_collections/arista/avd/,relocate-docs-requirements.txt --force
# Optional: Install AVD examples
cd test-avd-pr-4932
ansible-playbook arista.avd.install_examples

@github-actions github-actions bot added type: documentation Improvements or additions to documentation type: dependencies Pull requests that update a dependency file type: code quality CI and development toolset labels Jan 24, 2025
@carlbuchmann carlbuchmann requested a review from gmuloc January 24, 2025 18:51
@ClausHolbechArista ClausHolbechArista added this to the v5.2.0 milestone Jan 27, 2025
Copy link
Contributor

@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once the one in avd-docs is merged

@gmuloc gmuloc requested review from a team January 27, 2025 08:44
@ClausHolbechArista ClausHolbechArista merged commit a77b9f8 into aristanetworks:devel Jan 27, 2025
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Doc type: code quality CI and development toolset type: dependencies Pull requests that update a dependency file type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Update documentation requirements
3 participants