Aesthetic

[MaceKuailv]

Mainly about the notebooks. Also change the code to make the notebook prettier.

[MaceKuailv]

Good news: we have execute: auto

I have written a little script that process a notebook into a .md file. That repo will also host all of the sciserver specific notebooks in the future. The idea is that, at the end of the day, the dirty stuff has to go somewhere.

https://github.com/MaceKuailv/seaduck_sciserver_notebook

The sciserver notebooks (just one at this point) here are converted into jupytext-myst style markdown files. And I exclude it from executing.

The style check for markdown will break myst notebooks, so I excluded them in the check. This would not be a problem because the conversion from notebook to md is done by jupytext, which has pretty standard way of outputting stuff. This however means that the style check is going to fail for this PR because on the main branch the markdown check still want to fix the notebooks (and break them).

[MaceKuailv]

I was wrong about the style check.

@malmans2 what do you think overall?

[malmans2]

Hi @MaceKuailv, looks good!
All notebook in this repo will be executed when the documentation is compiled, right?
If yes, I would add the pre-commit hook that strips all notebook output:

- repo: https://github.com/kynan/nbstripout
  rev: 0.6.1
  hooks:
  - id: nbstripout

[malmans2]

Also, I suggest to print the seaduck version in the SciServer notebook:

import seaduck as sd

print(sd.__version__)

[MaceKuailv]

I will go ahead and incorporate the changes in a minute

[MaceKuailv]

Well, I may as well work on issue #26 from this PR as well, even though it is a bit low priority.

[MaceKuailv]

Address issue #13 #26 #27. The documentation certainly can use some improvement, but that's enough for this PR.