Documenter and refactor

[zjwegert]

Changes

• Added documentation and started Documenter.jl implementation
• Refactor src as discussed in Enhancement for paper: Refactor src, Write docs, Refactor package IO #34
• Clean parts of src
• Name change as discussed in Enhancement for paper: Refactor src, Write docs, Refactor package IO #34
• General naming improvements throughout scripts and src

@JordiManyer, this PR is still on-going work. If you have some time, feel free to have a look at the documentation and see what you think. Feel free to contribute (again if you have some time!).

FYI to call the package we need to add the required branches to the Project.toml in docs (e.g., Gridap#master etc.). Does pinning the packages sort this problem out?

[JordiManyer]

FYI to call the package we need to add the required branches to the Project.toml in docs (e.g., Gridap#master etc.). Does pinning the packages sort this problem out?

I guess if you add the Manifest that would pin them, but I would say we don't really want to do that for a release... We should just create a new release of the packages, and then we don't have to pin them.
It should not be a problem, except for GridapSolvers... I don't think I want to publish the GMG stuff I have in there until I'm closer to publishing (which should not be long, but yeah...). I'll have to talk to Santi. Maybe we can pin that one for now and create a new release for the others.

If the whole issue is that we need those branches for documentation, we can pin the branches in the CI job that deploys it. I can probably have a look at the CI stuff once this is merged on master.

[zjwegert]

I guess if you add the Manifest that would pin them, but I would say we don't really want to do that for a release... We should just create a new release of the packages, and then we don't have to pin them. It should not be a problem, except for GridapSolvers... I don't think I want to publish the GMG stuff I have in there until I'm closer to publishing (which should not be long, but yeah...). I'll have to talk to Santi. Maybe we can pin that one for now and create a new release for the others.

Sure we can create a release. Completely understand the point on GridapSolvers, let me know what you both decide.

If the whole issue is that we need those branches for documentation, we can pin the branches in the CI job that deploys it. I can probably have a look at the CI stuff once this is merged on master.

Sounds good! 👍

[zjwegert]

I'm going to merge this PR. Note that docs and script formatting is still in progress but this branch is massive.