Add option "buildtest tutorial-examples" to auto-generate documentation examples for Buildtest Tutorial

[prathmesh4321]

buildtest tutorial-examples

Hi @shahzebsiddiqui I still need to add tab completion for "buildtest tutorial-examples". I might need help with that.

[codecov]

Codecov Report

Base: 73.21% // Head: 73.13% // Decreases project coverage by -0.08% ⚠️

Coverage data is based on head (43acb47) compared to base (3b18650).
Patch coverage: 69.23% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #1307      +/-   ##
==========================================
- Coverage   73.21%   73.13%   -0.08%     
==========================================
  Files          55       56       +1     
  Lines        5886     5914      +28     
  Branches      997     1047      +50     
==========================================
+ Hits         4309     4325      +16     
- Misses       1577     1587      +10     
- Partials        0        2       +2     

Impacted Files	Coverage Δ
buildtest/cli/help.py	94.44% <ø> (ø)
buildtest/tools/tutorialexamples.py	52.00% <52.00%> (ø)
buildtest/cli/__init__.py	91.67% <100.00%> (+0.08%)	⬆️
buildtest/cli/buildspec.py	94.86% <100.00%> (ø)
buildtest/config.py	50.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[shahzebsiddiqui]

while you at it, please update https://buildtest.readthedocs.io/en/devel/contributing/build_documentation.html#generating-documentation-examples-for-buildtest-tutorial section of the docs to reflect the new command. I did a preliminary test and it seems to be working good job!

(buildtest) spack@b3da7219a082:~/buildtest$ buildtest tutorial-examples
======> Remove Test Directory
======> Removing Report File
======> Removing History Directory
======> Removing buildspec cache
Executing Command: buildtest build -b /home/spack/buildtest/examples/spack/install_specs.yml

[prathmesh4321]

while you at it, please update https://buildtest.readthedocs.io/en/devel/contributing/build_documentation.html#generating-documentation-examples-for-buildtest-tutorial section of the docs to reflect the new command. I did a preliminary test and it seems to be working good job!

(buildtest) spack@b3da7219a082:~/buildtest$ buildtest tutorial-examples
======> Remove Test Directory
======> Removing Report File
======> Removing History Directory
======> Removing buildspec cache
Executing Command: buildtest build -b /home/spack/buildtest/examples/spack/install_specs.yml

@shahzebsiddiqui I have added in the documentation. Please let me know if anything else needs to be added.

[shahzebsiddiqui]

while you at it, please update https://buildtest.readthedocs.io/en/devel/contributing/build_documentation.html#generating-documentation-examples-for-buildtest-tutorial section of the docs to reflect the new command. I did a preliminary test and it seems to be working good job!

(buildtest) spack@b3da7219a082:~/buildtest$ buildtest tutorial-examples
======> Remove Test Directory
======> Removing Report File
======> Removing History Directory
======> Removing buildspec cache
Executing Command: buildtest build -b /home/spack/buildtest/examples/spack/install_specs.yml

@shahzebsiddiqui I have added in the documentation. Please let me know if anything else needs to be added.

I think the documentation needs to be rewritten to emphasize the buildtest tutorial-examples command as pose to running via python. Looking at https://buildtest--1307.org.readthedocs.build/en/1307/contributing/build_documentation.html#generating-documentation-examples-for-buildtest-tutorial as reader i see the text in code-format python scripts/spack_container/doc-examples.py and i would be running this. But at the bottom you have text saying you can run buildtest tutorial-examples.

Could you rewrite the section and see if it makes sense to you. Pretend you are new contributor trying to understand this process of building documentation.