-
Notifications
You must be signed in to change notification settings - Fork 233
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: Added support for skip the TOC on fabric and device documentation #4796
Conversation
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-4796
# Activate the virtual environment
source test-avd-pr-4796/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/MaheshGSLAB/ansible-avd.git@issue-2243#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/MaheshGSLAB/ansible-avd.git#/ansible_collections/arista/avd/,issue-2243 --force
# Optional: Install AVD examples
cd test-avd-pr-4796
ansible-playbook arista.avd.install_examples |
...rista/avd/molecule/eos_cli_config_gen/inventory/host_vars/host3/device-documentation-toc.yml
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/host3.md
Outdated
Show resolved
Hide resolved
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
Conflicts have been resolved. A maintainer will review the pull request shortly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is missing eos_designs. We can do a separate PR for that, but then it is important that we do not close the issue. (change fixes #... to fixes part of #...)
...yavd/_eos_cli_config_gen/schema/schema_fragments/eos_cli_config_gen_documentation.schema.yml
Outdated
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/fabric_documentation_facts/__init__.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Change Summary
Added support for skip the TOC on fabric and device documentation.
Related Issue(s)
Fixes #2243
Component(s) name
arista.avd.<role-name>
Proposed changes
Added support for skip the TOC on fabric and device documentation
How to test
Run molecule
Checklist
User Checklist
Repository Checklist