mkdocs.md

MkDocs How To

This repo contains the content for the Ixia-c.dev web-site. It is built using the Material theme for MkDocs.

Prerequisites

• Python 3.10+. In the commands below we assume use have python3 executable. If you have a different name, change accordingly.

• PIP

  curl -sL https://bootstrap.pypa.io/get-pip.py | python3 -

• Virtualenv (recommended)

  pip install virtualenv

How to install

1. Clone this repository and create Python virtual environment

   git clone https://github.com/open-traffic-generator/ixia-c.git --recursive
   cd ixia-c
   git checkout -b __NEW_BRANCH_NAME__
   python3.10 -m venv venv
   source venv/bin/activate

2. Install required modules

   pip3 install -r requirements.txt

Update contents in the docs directory and verify locally prior to pushing to main branch of this repo on GitHub. Site will automatically update.

How to verify contents locally

1. Run the following command to render the content in real-time via a local web server:

   mkdocs serve

2. Alternatively, you can render all static html content in the site directory:

   mkdocs build

   You can point your browser to index.html in the site directory to view it.

Submodules

Parts of the docs hierarchy are coming from submodules. To update content of the submodules to the most recent one, use:

git submodule update --remote