📚 Move API documentation from User to Developer Docs

[s-weigand]

Since the API documentation is mainly aimed at developer is make more sense to have it in there than in the user docs.

Change summary

• Moved API documentation to the developer documentation section

Checklist

• ✔️ Passing the tests (mandatory!)

Closes issues

closes #601

[github-actions]

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

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[codecov]

Codecov Report

Merging #776 (5639dae) into main (5efcf0c) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #776   +/-   ##
=====================================
  Coverage   81.7%   81.7%           
=====================================
  Files         79      79           
  Lines       4024    4024           
  Branches     706     706           
=====================================
  Hits        3291    3291           
  Misses       606     606           
  Partials     127     127           

---

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 5efcf0c...5639dae. Read the comment docs.

[jsnel]

👍

[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]       [5639dae1]
     <v0.4.0>                   
       49.1±0.5ms       48.4±0.4ms     0.99  BenchmarkOptimize.time_optimize(False, False, False)
        269±0.4ms          266±4ms     0.99  BenchmarkOptimize.time_optimize(False, False, True)
       71.0±0.3ms         71.0±1ms     1.00  BenchmarkOptimize.time_optimize(False, True, False)
       72.9±0.2ms         71.8±2ms     0.98  BenchmarkOptimize.time_optimize(False, True, True)
       49.2±0.7ms       57.1±0.6ms    ~1.16  BenchmarkOptimize.time_optimize(True, False, False)
        269±0.7ms          275±4ms     1.02  BenchmarkOptimize.time_optimize(True, False, True)
+      70.9±0.3ms         83.5±1ms     1.18  BenchmarkOptimize.time_optimize(True, True, False)
+      73.4±0.5ms       84.8±0.6ms     1.16  BenchmarkOptimize.time_optimize(True, True, True)
             183M             183M     1.00  IntegrationTwoDatasets.peakmem_create_result
             204M             199M     0.98  IntegrationTwoDatasets.peakmem_optimize
          227±2ms          234±2ms     1.03  IntegrationTwoDatasets.time_create_result
       4.71±0.01s       5.70±0.05s    ~1.21  IntegrationTwoDatasets.time_optimize