Add docs + gh pages deploy

[dionhaefner]

A stub for docs to get you going. Will be deployed to GH pages whenever a PR is merged into main.

[Ceyron]

Thanks for the docs setup! :)

[dionhaefner]

@Ceyron I think you need to set the Pages source to "GitHub Actions" in the repo settings for the deploy to work

[Ceyron]

But this will make the documentation public already, doesn't it?

[dionhaefner]

No, GH Pages on private repos is private as well (only people with read access to the repo can see it).

[Ceyron]

This is the warning I get on the pages settings site.

[dionhaefner]

You don't have that? (Maybe it's an enterprise feature)

[Ceyron]

Seems to, this should only be available in enterprise

[Ceyron]

@dionhaefner, I have a question regarding the Python module system: What was the reason for excluding the submodules from all? Now the import via import exponax; exponax.normalized.XXX does no longer work.

[dionhaefner]

Did you re-run pip install? I made a change in pyproject.toml that should add these automatically.

[Ceyron]

In other experiment folders, I just use the repo as a separate folder from which I import (no installation). In these cases, the import no longer works.

[dionhaefner]

(no installation)

There's your problem :)

You can add the imports back, it doesn't hurt (just unnecessary in a sane setup).

[Ceyron]

I used Equinox as inspiration for this: https://github.com/patrick-kidger/equinox/blob/main/equinox/__init__.py

I also tried the module structure with installation (i.e., what you added with the PR). In these cases, I can do the following

from exponax import stepper

diffusions_stepper = stepper.Diffusion(1, 3.0, 50, 0.1)

but the following does not work:

import exponax as ex

diffusions_stepper = ex.stepper.Diffusion(1, 3.0, 50, 0.1)

Probably, there are proper names for both importing strategies. I would like the latter, which seemingly only works when I have the submodule export in the top-level __init__.py (even with installation).

Or did I do anything incorrectly? For installation, I cloned the repo, cd'ed into the directory, and ran pip install .

[dionhaefner]

True, if you never import exponax.stepper from within the top-level module (that is, __init__.py or any submodule imported from it) it won't be loaded at import. You can verify that it works with exponax.etdrk, which is imported from _base_stepper.py.

So yea just add the submodule imports back here if you explicitly want to support that use case.