FTheory: More documentation and related improvements

[HereAround]

Release notes:

• #5071 Extended flexibility for HypersurfaceModel constructors.
• #5071 Improved implementation of set_weierstrass_model(h::HypersurfaceModel).
• #5071 Improved implementation of set_global_tate_model(h::HypersurfaceModel).
• #5071 Breaking: Remove support for sample_toric_variety().
• #5071 Breaking: Remove support for weierstrass_model(w::WeierstrassModel).

What is in this PR:

• Restructure documentation text.
• Improve documentation text and various doc strings.
• Document hypersurface_equation for Weierstrass and global Tate models.
• General code styling.
• Remove/update comments.
• Remove "# Examples" from all doc strings for consistency.
• Added doc strings and examples to methods for which this was missing.
• Remove all uses of literature models in doc string examples, that appear before literature models are introduced.
• Introduce new and long desired constructors for hypersurface models. Namely, the provided twists need not be for the first two fiber ambient coordinates, but can now be specified for any two fiber ambient coordinates.
• Improve implementation of set_weierstrass_model and set_global_tate_model for hypersurface models.
• Stop support for function sample_toric_variety.
• Stop support for the following function:

function weierstrass_model(w::WeierstrassModel)
  @vprint :FTheoryModelPrinter 0 "Weierstrass model provided, returning this very model.\n"
  return w
end

Preview of the overhauled documentation should become available at https://docs.oscar-system.org/previews/PR5071/Experimental/FTheoryTools/introduction/.

[codecov]

Codecov Report

Attention: Patch coverage is 89.47368% with 8 lines in your changes missing coverage. Please review.

Project coverage is 84.89%. Comparing base (b1aab33) to head (80b821f).
Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
.../FTheoryTools/src/HypersurfaceModels/attributes.jl	60.00%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5071      +/-   ##
==========================================
- Coverage   84.90%   84.89%   -0.01%     
==========================================
  Files         706      706              
  Lines       95421    95482      +61     
==========================================
+ Hits        81017    81064      +47     
- Misses      14404    14418      +14     

Files with missing lines	Coverage Δ
...heoryTools/src/AbstractFTheoryModels/attributes.jl	96.52% <ø> (ø)
.../FTheoryTools/src/AbstractFTheoryModels/methods.jl	66.96% <ø> (ø)
...al/FTheoryTools/src/FamilyOfG4Fluxes/attributes.jl	80.59% <ø> (ø)
.../FTheoryTools/src/FamilyOfG4Fluxes/constructors.jl	68.88% <ø> (ø)
...ental/FTheoryTools/src/FamilyOfG4Fluxes/methods.jl	96.96% <ø> (ø)
...Tools/src/FamilyOfG4Fluxes/special_constructors.jl	96.80% <ø> (ø)
...perimental/FTheoryTools/src/G4Fluxes/attributes.jl	63.75% <ø> (ø)
...xperimental/FTheoryTools/src/G4Fluxes/auxiliary.jl	94.60% <ø> (ø)
...rimental/FTheoryTools/src/G4Fluxes/constructors.jl	80.86% <ø> (ø)
...perimental/FTheoryTools/src/G4Fluxes/properties.jl	100.00% <ø> (ø)
... and 14 more

... and 13 files with indirect coverage changes

🚀 New features to boost your workflow:

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

[emikelsons]

Why are we removing # Examples, isn't the use of this subtitle above code samples common practice throughout the Oscar docs?

[HereAround]

At least we (=FTheoryTools) were not consistent with this. To me it seemed that most of the FTheoryTools doc strings did not have the #Example and so I removed it.

(I also like simplicity. To me it seems clear that what follows below the description is an example. So why state the obvious? But this is definitely not too important and maybe even incorrect - perceptions can be different.)

I am happy to add this back if you feel this is preferred, but then adding it to all doc strings.

[emikelsons]

I don't really have a strong opinion either way and was just pointing out what I had noticed, but maybe it's best then to leave these changes.

[lgoettgens]

According to our style guide (https://docs.oscar-system.org/dev/DeveloperDocumentation/documentation/#Docstrings-of-exported-functions), the # Examples should be there

[emikelsons]

Looks good and the tests seem to pass!