End user documentation for Interactive Path Analysis Tool (VPR server mode)

[w0lek]

Description

End user documentation for Interactive Path Analysis Tool (VPR server mode).

Motivation and Context

Allows maintaining and enhancing the Server mode feature for other developers by providing end-user documentation, API documentation, etc.

How Has This Been Tested?

cd doc && make html
reviewing result index.html

Types of changes

• code formatting change
• code commenting coverage
• end user doc

[AlexandreSinger]

@w0lek Please be aware that every time you push to this branch it is independently calling the CI. So, from this morning alone you have called the CI 10 times which are all running in parallel. I recommend making a set of commits and pushing when you intend on having the code tested and reviewed.

[w0lek]

@w0lek Please be aware that every time you push to this branch it is independently calling the CI. So, from this morning alone you have called the CI 10 times which are all running in parallel. I recommend making a set of commits and pushing when you intend on having the code tested and reviewed.

@AlexandreSinger sorry about that.
I still need push changes with minor steps to sync and execute my local build node, which is setup to build the doc target. My main dev machine cannot do a doc target build(i suspect due to old ubuntu version). So for me pushing minor changes is necessary sometimes.
If i create new dev branch from branch ipa_end_user_doc which doesn't involved in the PR, aggregate my changes there, and merge them at final into ipa_end_user_doc when i done with all changes, will that not trigger CI at each minor commit, right?
I am going to try that, please let me know, if i still flood the CI.

[AlexandreSinger]

@w0lek I completely understand your issue. I have a PR currently waiting to be merged which will resolve this issue: #2589

This PR will cancel previous runs on branches where the CI is called again.

If you were to raise a branch on your own fork and push to that branch it should not call the CI on our side anymore. Thank you for your understanding!

[w0lek]

@vaughnbetz thank you for the review! i have corrected all review tasks.
FYI: i am going to vacation during this week, so if there will be new finding, i will be able to make a corrections on next week only.
FYI2: The Interactive Path Analysis client implementation is under developing, after vacation i will create PR with it. I didn't forget, sorry for delay with that.

[vaughnbetz]

Thanks @w0lek ! Have a great and well-deserved vacation :).