docs update

[cortner]

I'd like to bring the docs up to date before tagging 0.2. Any help would be appreciated.

@DexuanZhou -- it seems the really nice spherical harmonics docs you wrote don't render correctly. Would you mind looking into that?

To view docs locally

• go to Polynomials4ML/docs
• julia --project=. => ] up => exit repl
• julia --project=. make.jl
• the docs pages should now be available under docs/build

[cortner]

• [ ] write brief description of ACE layers
• [ ] should we document use of Dual and HyperDual compatibility?
• [ ] should we provide a few simple tutorials, see ACE1pack.jl for examples?
• [ ] remove Experimental.md entirely from the docs? we can keep the md file.

[DexuanZhou]

I'd like to bring the docs up to date before tagging 0.2. Any help would be appreciated.

@DexuanZhou -- it seems the really nice spherical harmonics docs you wrote don't render correctly. Would you mind looking into that?

To view docs locally

* go to `Polynomials4ML/docs`

* `julia --project=.` => `] up` => exit repl

* `julia --project=. make.jl`

* the docs pages should now be available under `docs/build`

I'd like to bring the docs up to date before tagging 0.2. Any help would be appreciated.

@DexuanZhou -- it seems the really nice spherical harmonics docs you wrote don't render correctly. Would you mind looking into that?

To view docs locally

* go to `Polynomials4ML/docs`

* `julia --project=.` => `] up` => exit repl

* `julia --project=. make.jl`

* the docs pages should now be available under `docs/build`

[DexuanZhou]

Sorry, I originally wanted to comment 'Sure, I'll look at it right away,' but I accidentally closed the pull request.

[cortner]

Hi @CheukHinHoJerry and @DexuanZhou -- I just accidentally force-pushed an update. Did either of you push to this branch? If you did please keep your local copy so you can apply this again. sorry If I created a mess.

[cortner]

@DexuanZhou -- lookup the Documenter.jl documentation to see how to write Latex in Documenter.

Both -- checkout the first Literate.jl tutorial I wrote. I'd like to add a few more. Let me know if you have suggestions.

[cortner]

@DexuanZhou -- I found your commit that I accidentally overwrote:

https://github.com/ACEsuit/Polynomials4ML.jl/commit/8f0f245b9d82c4bd563aea5b399e92a38b18cda4

If you still have the corrected file, can you please commit it again? If not I will try to recover this tomorrow.

[CheukHinHoJerry]

I think it should be okay now? I think what Git did was just auto-merged @DexuanZhou 's commit in my local repo and @cortner 's remote branch without conflict when I tried to pull.

[cortner]

yes! all good, I'm glad, thanks for pointing it out.

[cortner]

some links are broken, but otherwise I think this is ok-ish. Not great, but a start.

[cortner]

@DexuanZhou and @CheukHinHoJerry -- I think this is more or less ready. I'd be greatful if you can take another look and let me know if you think anything is missing or not working as expected.

[CheukHinHoJerry]

Some links in SH.md is not working and I fixed it.

Another thing is that I cannot find SparseSymprod and PooledSparseProduct in docstrings, is this on purpose?

Other than the two above it looks good to me.

[cortner]

hm - one last thing we should consider is updating the readme.

[cortner]

Another thing is that I cannot find SparseSymprod and PooledSparseProduct in docstrings, is this on purpose?

THey should be - works for me locally.

[cortner]

There are still some broken links but I am getting tired of trying to figure out Documenter. It's not too big a deal. I'm happy to merge and register this as 0.2.0 if @CheukHinHoJerry and @DexuanZhou agree?

[CheukHinHoJerry]

No problem from my end.

[DexuanZhou]

I'm okay with it

[cortner]

Thank you both