Index: docs/Makefile =================================================================== diff -u -rb93016ee67204223658152cb2952e8ab16af1b94 -r841c9b6ef78c51e0e323e06b937d97e8a95f8f4a --- docs/Makefile (.../Makefile) (revision b93016ee67204223658152cb2952e8ab16af1b94) +++ docs/Makefile (.../Makefile) (revision 841c9b6ef78c51e0e323e06b937d97e8a95f8f4a) @@ -4,7 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -SPHINXPROJ = Dialin +SPHINXPROJ = Leahi_Dialin SOURCEDIR = source BUILDDIR = build Index: docs/source/README.rst =================================================================== diff -u -rb93016ee67204223658152cb2952e8ab16af1b94 -r841c9b6ef78c51e0e323e06b937d97e8a95f8f4a --- docs/source/README.rst (.../README.rst) (revision b93016ee67204223658152cb2952e8ab16af1b94) +++ docs/source/README.rst (.../README.rst) (revision 841c9b6ef78c51e0e323e06b937d97e8a95f8f4a) @@ -2,9 +2,9 @@ :target: images/logo.jpg :alt: Diality -The Dialin API supports cross-functional testing of the Denali system. +The Leahi Dialin API supports cross-functional testing of the Leahi system. It supports the Systems level testing, Software Verification & Validation, and pre-release SW and FW developmental -testing by exposing and simulating interaction with the UI, HD, and DG sub-components. +testing by exposing and simulating interaction with the TD, DD, and IOFP sub-components. To use this API, it is recommended to install the API directly from a pre-packaged .whl file. Once installed to your local virtual python environment with pip, you can import modules as needed to develop your tests. @@ -27,7 +27,7 @@ virtualenv --python=python3 venv source venv/bin/activate - pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git + pip3 install git+ssh://git@dvm-linux02:7999/vv/leahi-dialin.git How to install a specific release version (Not yet available) @@ -38,7 +38,7 @@ virtualenv --python=python3 venv source venv/bin/activate branch="0.0.1" # update the branch_name here - pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch + pip3 install git+ssh://git@dvm-linux02:7999/vv/leahi-dialin.git@$branch Install from a pre-built .whl file: ================================== @@ -49,7 +49,7 @@ virtualenv --python=python3 venv source venv/bin/activate - pip3 install dialin-0.0.1-py3-none-any.whl + pip3 install leahi_dialin-0.0.1-py3-none-any.whl Examples ================================== @@ -75,7 +75,7 @@ (venv) $ cd tests (venv) $ python3 dialin_unit_test_example.py -Building the Dialin package +Building the Leahi Dialin package ================================== .. code-block:: Index: docs/source/conf.py =================================================================== diff -u -r2138d06d100fdcf23f2e9069f35ee2fdee62008f -r841c9b6ef78c51e0e323e06b937d97e8a95f8f4a --- docs/source/conf.py (.../conf.py) (revision 2138d06d100fdcf23f2e9069f35ee2fdee62008f) +++ docs/source/conf.py (.../conf.py) (revision 841c9b6ef78c51e0e323e06b937d97e8a95f8f4a) @@ -23,7 +23,7 @@ import os import sys sys.path.insert(0, os.path.abspath('../../')) -from dialin import __version__ as VERSION +from leahi_dialin import __version__ as VERSION # -- General configuration ------------------------------------------------ @@ -52,9 +52,9 @@ master_doc = 'index' # General information about the project. -project = 'Dialin' -copyright = '2020, Diality Inc' -author = 'Peter Lucia' +project = 'Leahi Dialin' +copyright = '2025, Diality Inc' +author = 'Michael Garthwaite' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -118,7 +118,7 @@ # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. -htmlhelp_basename = 'Dialindoc' +htmlhelp_basename = 'Leahidialindoc' # -- Options for LaTeX output --------------------------------------------- @@ -145,7 +145,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'Dialin.tex', 'Dialin Documentation', + (master_doc, 'Dialin.tex', 'Leahi Dialin Documentation', 'Peter Lucia', 'manual'), ] @@ -155,7 +155,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'leahi_dialin', 'Dialin Documentation', + (master_doc, 'leahi_dialin', 'Leahi Dialin Documentation', [author], 1) ] @@ -166,7 +166,7 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Dialin', 'Dialin Documentation', - author, 'Dialin', 'One line description of project.', + (master_doc, 'Leahi Dialin', 'Leahi Dialin Documentation', + author, 'Leahi Dialin', 'One line description of project.', 'Miscellaneous'), ] Index: docs/source/index.rst =================================================================== diff -u -rb93016ee67204223658152cb2952e8ab16af1b94 -r841c9b6ef78c51e0e323e06b937d97e8a95f8f4a --- docs/source/index.rst (.../index.rst) (revision b93016ee67204223658152cb2952e8ab16af1b94) +++ docs/source/index.rst (.../index.rst) (revision 841c9b6ef78c51e0e323e06b937d97e8a95f8f4a) @@ -1,21 +1,21 @@ .. ........................................................................... .. -.. Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. +.. Copyright (c) 2019-2025 Diality Inc. - All Rights Reserved. .. .. THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN .. WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. .. .. @file index.rst .. -.. @date 20-July-2020 -.. @author P. Lucia +.. @date 25-February-2025 +.. @author M. Garthwaite .. -.. @brief Dialin documentation master file +.. @brief Leahi Dialin documentation master file .. .. .. ........................................................................... -.. Dialin documentation master file, created by +.. Leahi Dialin documentation master file, created by sphinx-quickstart on Fri May 29 15:33:59 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. @@ -28,7 +28,7 @@ * :ref:`search` -Dialin API Documentation +Leahi Dialin API Documentation ================================== .. contents:: .. include:: README.rst Index: tools/document.sh =================================================================== diff -u -r07db7b5f01ad17d60c190e21574e1ed0552535ff -r841c9b6ef78c51e0e323e06b937d97e8a95f8f4a --- tools/document.sh (.../document.sh) (revision 07db7b5f01ad17d60c190e21574e1ed0552535ff) +++ tools/document.sh (.../document.sh) (revision 841c9b6ef78c51e0e323e06b937d97e8a95f8f4a) @@ -35,7 +35,7 @@ cd $CURR_DIR fi cd ../ -sphinx-apidoc -o docs/source leahi-dialin +sphinx-apidoc -o docs/source leahi_dialin/ cd docs/ if [[ "$@" == "*--clean*" ]]; then make clean