Improve look of documentation website

[Dref360]

We have several possibilities:

• Move to Mkdocs Material
• Update our CSS

In all cases, we should redo the tree structure to be more "Profesh"

[Dref360]

Using mkdocs-material I can get this type of look.

What do we think about it? @parmidaatg @GeorgePearse . Once we have a new logo, we can switch it up as well.

Branch: docs/mkdocs

• After running poetry install, run poetry run mkdocs serve to serve the documentation.

Plugin for notebooks: https://github.com/danielfrg/mkdocs-jupyter
Plugin for look: https://squidfunk.github.io/mkdocs-material/
Plugin for API doc: https://github.com/mkdocstrings/mkdocstrings

I previously worked with mkdocs-material:

• servicenow.github.io/azimuth
• https://dref360.github.io/spectral-metric/

[GeorgePearse]

Yeah looks good. Think the next thing would be to try to make it a place with lots of great documentation / easy intros into Active Learning and the motivation behind it / a very good research paper store.

A one stop-shop for all things Bayesian Active Learning.

[Dref360]

I made a lot of work on the branch docs/mkdocs, would appreciate if someone would run it locally and give some feedback. I'll continue next week.

[GeorgePearse]

Will run locally tonight

[GeorgePearse]

Don't know if I'm being an idiot, hit this

(baal-docs) (base) [georgep@<ip-name> docs]$ poetry install
Installing dependencies from lock file

  SolverProblemError

  Because lightning-flash (rev master) depends on jsonargparse (>=3.17.0,<=4.9.0) which doesn't match any versions, lightning-flash is forbidden.
  So, because baal depends on lightning-flash (branch master), version solving failed.

  at ~/anaconda3/lib/python3.8/site-packages/poetry/puzzle/solver.py:241 in _solve
      237│             packages = result.packages
      238│         except OverrideNeeded as e:
      239│             return self.solve_in_compatibility_mode(e.overrides, use_latest=use_latest)
      240│         except SolveFailure as e:
    → 241│             raise SolverProblemError(e)
      242│ 
      243│         results = dict(
      244│             depth_first_search(
      245│                 PackageNode(self._package, packages), aggregate_package_nodes
      ```

[Dref360]

Maybe poetry clean --all ? and then poetry install?

Otherwise, the new deps are ;

# Documentation
mkdocs-jupyter = "^0.21.0"
mkdocs-material = "^8.3.6"
Pygments = "^2.12.0"
mkdocstrings = {extras = ["python"], version = "^0.18.1"}

so you can build around with: poetry run pip install mkdocs-jupyter mkdocs-material Pygments mkdocstrings[python]

[GeorgePearse]

So so much nicer than before (work around with specified packages did the trick)

[GeorgePearse]

There's the double "None" on the tutorials page. Also lemme if you know about loose ends and would prefer feedback on what's already there / looks complete.

[GeorgePearse]

Would be really nice to either have a timeline for the papers, or a grid with links to them and some categorisation in terms of the types of content / focus of the techniques.

[GeorgePearse]

Another None

[GeorgePearse]

I don't see a "Getting started" type tab, or an installation (just with a link to https://pypi.org/project/baal/)

[Dref360]

Forgot to commit the symlink to notebooks. just fixed many issues as well.