Hide runtime info behind <details> (#104)

* resolves #100

* try it out for notebooks

* Update docs/literate.jl

* explicit html for notebook

* Update docs/literate.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* pre-1.7 compat

* Update docs/literate.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* add horizontal rules at top and bottom

* fix notebook/documenter link discrepancy

* bugfix

* fix hrules

* fix markdown

* fixup

* fix notebook formatting

* use Markdown.htmlesc

* separate System information section ......

* Fix file size of notebook (#103)

* Fix file size of notebook

* Fix format

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Change comment

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* CompatHelper: bump compat for "GPLikelihoods" to "0.3" (#107)

* CompatHelper: bump compat for "GPLikelihoods" to "0.3"

* Reorder Gamma parametrization

* Update project versions

* Missing one

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Théo Galy-Fajou <[email protected]>

* Fix outdated `literate.jl` script (#111)

* Fix outdated `literate.jl` script

* Fix format

* Split code into submodules for the different approximations (#96)

* stab at submodules

* move approx_lml to API

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* clean up imports

* remove unused imports

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docfix

* missing import

* test: remove submodules from api docs

* subpages in docs

* hide private API docstrings

* mention types in api/index.md

* qualify

* remove extra line

* minor bump#

* change docs/ compat

* update test compat

* explicitly `@reexport` to avoid exporting the submodules!

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* add likelihood imports

* add import

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* add import

* Update src/SparseVariationalApproximationModule.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Rename the test files (#113)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: David Widmann <[email protected]>
Co-authored-by: Théo Galy-Fajou <[email protected]>
Co-authored-by: Ross Viljoen <[email protected]>

Author: 5 people

docs/literate.jl

@@ -16,16 +16,15 @@ Pkg.instantiate()
 pkg_status = sprint() do io
     Pkg.status(; io=io)
 end
-manifest_status = sprint() do io
-    Pkg.status(; io=io, mode=Pkg.PKGMODE_MANIFEST)
-end
 
 using Literate: Literate
 
 const MANIFEST_OUT = joinpath(EXAMPLE, "Manifest.toml")
 mkpath(joinpath(OUTDIR, EXAMPLE))
 cp(joinpath(EXAMPLEPATH, "Manifest.toml"), joinpath(OUTDIR, MANIFEST_OUT); force=true)
 
+using Markdown: htmlesc
+
 function preprocess(content)
     # Add link to nbviewer below the first heading of level 1
     sub = SubstitutionString(
@@ -45,6 +44,8 @@ function preprocess(content)
 # [Julia source file](@__REPO_ROOT_URL__/examples/@__NAME__/script.jl).
 #md # The corresponding notebook can be viewed in [nbviewer](@__NBVIEWER_ROOT_URL__/examples/@__NAME__.ipynb).*
 #nb # The rendered HTML can be viewed [in the docs](https://juliagaussianprocesses.github.io/ApproximateGPs.jl/dev/examples/@__NAME__/).*
+#
+#md # ---
 #
         """,
     )
@@ -53,37 +54,34 @@ function preprocess(content)
     # remove VSCode `##` block delimiter lines
     content = replace(content, r"^##$."ms => "")
 
-    # adds the current version of the packages
-    append = """
-    # ### Package and system information
-    # #### Package version
-    # ```julia
-    $(chomp(replace(pkg_status, r"^"m => "# ")))
-    # ```
-    # #### Computer information
-    # ```
-    $(chomp(replace(sprint(InteractiveUtils.versioninfo), r"^"m => "# ")))
-    # ```
-    # #### Manifest
-    # To reproduce this notebook's package environment, you can [download the full Manifest.toml]($(MANIFEST_OUT)).
-    """
-    # This regex add "# " at the beginning of each line
-    # chomp removes trailing newlines
+    """ The regex adds "# " at the beginning of each line; chomp removes trailing newlines """
+    literate_format(s) = chomp(replace(s, r"^"m => "# "))
 
-    # The following gives a preview of the manifest
-    # embedded in a "spoiler", but this is unfortunately very buggy
-    # ```@raw html
+    # <details></details> seems to be buggy in the notebook, so is avoided for now
+    info_footer = """
+    #md # ```@raw html
+    # <hr />
+    # <h6>Package and system information</h6>
     # <details>
-    # <summary> Show the full Manifest </summary>
-    # ```
-    # ```julia
-    # $(chomp(replace(manifest_status, r"^"m => "# ")))
-    # ```
-    # ```@raw html
+    # <summary>Package information (click to expand)</summary>
+    # <pre>
+    $(literate_format(htmlesc(pkg_status)))
+    # </pre>
+    # To reproduce this notebook's package environment, you can
+    #nb # <a href="$(MANIFEST_OUT)">
+    #md # <a href="../$(MANIFEST_OUT)">
+    # download the full Manifest.toml</a>.
     # </details>
-    # ```
+    # <details>
+    # <summary>System information (click to expand)</summary>
+    # <pre>
+    $(literate_format(htmlesc(sprint(InteractiveUtils.versioninfo))))
+    # </pre>
+    # </details>
+    #md # ```
+    """
 
-    return content * append
+    return content * info_footer
 end
 
 # Convert to markdown and notebook