[docs] Clarified generated documentation output #93

	---
	name: Netengine CI Build

	on:
	push:
	branches:
	- master
	pull_request:
	branches:
	- master

	jobs:
	build:
	name: Python==${{ matrix.python-version }}
	runs-on: ubuntu-24.04

	strategy:
	fail-fast: false
	matrix:
	python-version:
	- "3.10"
	- "3.11"
	- "3.12"
	- "3.13"

	steps:
	- uses: actions/checkout@v7
	with:
	ref: ${{ github.event.pull_request.head.sha }}

	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v7
	with:
	python-version: ${{ matrix.python-version }}
	cache: "pip"
	cache-dependency-path: \|
	*/requirements.txt

	- name: Install Dependencies
	id: deps
	run: \|
	pip install -U pip wheel setuptools
	pip install -U -r requirements-test.txt
	pip install -U -e .

	- name: Run QA Checks
	run: ./run-qa-checks

	- name: Run tests
	if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}
	run: \|
	coverage run runtests.py
	coverage combine
	coverage xml

	- name: Upload Coverage
	if: ${{ success() }}
	uses: coverallsapp/github-action@v2
	with:
	parallel: true
	format: cobertura
	flag-name: python-${{ matrix.python-version }}
	github-token: ${{ secrets.GITHUB_TOKEN }}

	coveralls:
	needs: build
	runs-on: ubuntu-latest
	steps:
	- name: Coveralls Finished
	uses: coverallsapp/github-action@v2
	with:
	parallel-finished: true

Navigation Menu