📚 Add docs for the CLI

[s-weigand]

Added docs for the CLI.

Change summary

Links to the changed sections

• Command-line Interface

Checklist

• ✔️ Passing the tests (mandatory!)

[github-actions]

👈 Launch a binder notebook on branch s-weigand/pyglotaran/cli-docs

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.05%.

Quality metrics	Before	After	Change
Complexity	1.00 ⭐	1.00 ⭐	0.00
Method Length	253.00 ⛔	254.00 ⛔	1.00 👎
Working memory	8.00 🙂	8.00 🙂	0.00
Quality	58.40% 🙂	58.35% 🙂	-0.05% 👎

Other metrics	Before	After	Change
Lines	292	293	1

Changed files	Quality Before	Quality After	Quality Change
docs/source/conf.py	58.40% 🙂	58.35% 🙂	-0.05% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[jsnel]

👍

[codecov]

Codecov Report

Merging #784 (26a80ba) into staging (a464ec3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           staging    #784   +/-   ##
=======================================
  Coverage     83.9%   83.9%           
=======================================
  Files           75      75           
  Lines         4185    4185           
  Branches       752     752           
=======================================
  Hits          3512    3512           
  Misses         538     538           
  Partials       135     135           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a464ec3...26a80ba. Read the comment docs.

[github-actions]

Benchmark is done. Checkout the benchmark result page.
Benchmark differences below 5% might be due to CI noise.

Benchmark diff

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [dc00e6da]       [26a80ba4]
     <v0.4.0>                   
-        44.1±2ms       36.1±0.4ms     0.82  BenchmarkOptimize.time_optimize(False, False, False)
-         247±3ms       43.5±0.8ms     0.18  BenchmarkOptimize.time_optimize(False, False, True)
         65.5±1ms         60.4±2ms     0.92  BenchmarkOptimize.time_optimize(False, True, False)
         67.5±2ms       63.5±0.5ms     0.94  BenchmarkOptimize.time_optimize(False, True, True)
       43.7±0.2ms       47.3±0.5ms     1.08  BenchmarkOptimize.time_optimize(True, False, False)
-         245±3ms         156±60ms     0.64  BenchmarkOptimize.time_optimize(True, False, True)
+      64.4±0.7ms         73.7±1ms     1.14  BenchmarkOptimize.time_optimize(True, True, False)
+        68.1±2ms        80.3±40ms     1.18  BenchmarkOptimize.time_optimize(True, True, True)
             179M             182M     1.01  IntegrationTwoDatasets.peakmem_create_result
             200M             200M     1.00  IntegrationTwoDatasets.peakmem_optimize
-         212±5ms          183±2ms     0.87  IntegrationTwoDatasets.time_create_result
-      4.39±0.03s       1.29±0.02s     0.29  IntegrationTwoDatasets.time_optimize