Fix documentation on master

JuliaManifolds / Manifolds.jl

Manifolds.jl provides a library of manifolds aiming for an easy-to-use and fast implementation.

https://juliamanifolds.github.io/Manifolds.jl

MIT License

366 stars 52 forks source link

Fix documentation on master #694

Closed kellertuer closed 8 months ago

kellertuer commented 8 months ago

This fixes the error but also most warnings for the docs on master, since we missed to preview on last PR.

[x] There seems to be one $ somewhere in the docs now
[x] there seem to be a few warnings for missing docs from extensions?
[x] We could maybe use an emoji upfront links that point to ManifoldsBase? I just did not yet have a good idea which one – or we could use the base symbol if that is not too hard to include in text.

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (deede80) 99.57% compared to head (69fc621) 99.57%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #694 +/- ## ======================================= Coverage 99.57% 99.57% ======================================= Files 108 108 Lines 10708 10708 ======================================= Hits 10663 10663 Misses 45 45 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mateuszbaran commented 8 months ago

[ ] There seems to be one $ somewhere in the docs now

It's hard to trace it without at least file name unless we replace all dollar signs with backticks for math.

there seem to be a few warnings for missing docs from extensions?

IIRC they were there for a long time.

[ ] We could maybe use an emoji upfront links that point to ManifoldsBase? I just did not yet have a good idea which one – or we could use the base symbol if that is not too hard to include in text.

Can it be done automatically? If not, it would be yet another chore to keep it consistent.

kellertuer commented 8 months ago

Yes, I looked for the $ a bit but that might really be hard to track down, since Documenter does not (yet) provide the details which file that happens on.

I also checked whether we can maybe prefix ManifoldsBase.jl links with some symbol / emoji, but had no-good idea, so with the updated news entry to today, I think this should be fine as is and we leave the rest for someone (tm) with too much time and/or creativity :D

For the missing docs – it would also at some point be nice to document them, but not so urgent I think.

edit: so as soon as tests pass I'll merge this and register it to continue on Manopt the its two PRs :)