Fix-up docs content and infrastructure

[abhro]

• Update gitignore to ignore artifacts created during docs building
• Use [sources] attribute in docs/Project.toml, as supported by Pkg.toml v1.11+ for docs to maintain its dependency on FHist itself.
  This does imply we should run docs on Julia v1.11+, but given that it's essentially a separate environment, and also not what we're promising the registry, it should be fine since CI automatically picks the newest version anyway.
  It also lets us do away with the Pkg.develop() call in the notebooks.
• Add headings to docs notebooks
• Update example blocks
• Fix-up various docstrings

Each commit and its associated message contains a more atomic change and its description.

[Moelf]

hi, this looks like purely formatting change?

[abhro]

Some of it, but there are some changes that I still haven't committed, ergo the draft phase 😅

[Moelf]

thanks in advance!

[github-actions]

Benchmark Results (Julia v1)

Time benchmarks

	main	63b31c5...	main / 63b31c5...
Non-Uniform Binning/One-shot Gaussian input	16.3 ± 0.072 ms	17 ± 0.7 ms	0.962 ± 0.04
Non-Uniform Binning/One-shot Gaussian input with weights	16.9 ± 0.054 ms	17.9 ± 0.78 ms	0.943 ± 0.041
Non-Uniform Binning/One-shot Uniform input	15.5 ± 0.061 ms	16.9 ± 0.8 ms	0.922 ± 0.044
Non-Uniform Binning/One-shot Uniform input with weights	16.2 ± 0.13 ms	16.7 ± 0.72 ms	0.97 ± 0.043
Uniform Binning/One-shot Gaussian input	7.54 ± 0.055 ms	7.34 ± 0.03 ms	1.03 ± 0.0086
Uniform Binning/One-shot Gaussian input with weights	10.6 ± 0.092 ms	10.7 ± 0.049 ms	0.997 ± 0.0098
Uniform Binning/One-shot Uniform input	1.74 ± 0.0078 ms	1.74 ± 0.0074 ms	1 ± 0.0062
Uniform Binning/One-shot Uniform input with weights	7.83 ± 0.027 ms	7.7 ± 0.031 ms	1.02 ± 0.0054
Uniform Binning/atomic_push!-loop Gaussian input	12 ± 0.041 ms	12 ± 0.072 ms	0.998 ± 0.0069
Uniform Binning/push!-loop Uniform input	2.05 ± 0.013 ms	2.05 ± 0.014 ms	1 ± 0.0091
time_to_load	0.282 ± 0.0037 s	0.286 ± 0.00061 s	0.987 ± 0.013

Memory benchmarks

	main	63b31c5...	main / 63b31c5...
Non-Uniform Binning/One-shot Gaussian input	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Non-Uniform Binning/One-shot Gaussian input with weights	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Non-Uniform Binning/One-shot Uniform input	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Non-Uniform Binning/One-shot Uniform input with weights	11 allocs: 0.469 kB	11 allocs: 0.469 kB	1
Uniform Binning/One-shot Gaussian input	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/One-shot Gaussian input with weights	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/One-shot Uniform input	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/One-shot Uniform input with weights	10 allocs: 0.547 kB	10 allocs: 0.547 kB	1
Uniform Binning/atomic_push!-loop Gaussian input	7 allocs: 0.344 kB	7 allocs: 0.344 kB	1
Uniform Binning/push!-loop Uniform input	7 allocs: 0.344 kB	7 allocs: 0.344 kB	1
time_to_load	0.145 k allocs: 11 kB	0.145 k allocs: 11 kB	1

[tamasgal]

The whitespace (“retabbing”) changes are not necessary in my opinion. They do not add more value to the code and obfuscate the “git blame” feature.

[abhro]

The whitespace (“retabbing”) changes are not necessary in my opinion. They do not add more value to the code and obfuscate the “git blame” feature.

I think the reason I did it for the notebooks is that since they get picked up by Documenter, it shows up differently on the docs pages. I do agree about the git blame obfuscation thing. I'm going to rebase and remove the whitespace related commits 👍

I would still like to propose that a retabbing PR later be made, with a .git-blame-ignore-revs file to handle the git blame, if that's acceptable?

[tamasgal]

I think that's a good idea 🙂

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.73%. Comparing base (fe14f0f) to head (63b31c5).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #172   +/-   ##
=======================================
  Coverage   77.73%   77.73%           
=======================================
  Files          11       11           
  Lines         858      858           
=======================================
  Hits          667      667           
  Misses        191      191           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.