Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
utensil committed Apr 7, 2024
1 parent d749274 commit 44caa2c
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 37 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ notebook/profile_results.svg
docs/build/
docs/src/index.md
.vscode/settings.json
docs/Manifest.toml
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ The package can be installed with the Julia package manager. From the Julia REPL
dev https://github.com/pygae/GAlgebra.jl.git
```

The installation process will take a while, because it will install [PyCall.jl](https://github.com/JuliaPy/PyCall.jl) and its dependencies and it will also use `pip` to install [GAlgebra](https://github.com/pygae/galgebra) if you haven't. If you wish to use a version other than the latest released version of GAlgebra that will be installed by [deps/build.jl](deps/build.jl), you can install that via pip before/after the installation of `GAlgebra.jl`, e.g. `pip install -e <your local path to GAlgebra>` or `pip install https://github.com/pygae/galgebra/archive/master.zip`.
The installation process will take a while, because it will install [PyCall.jl](https://github.com/JuliaPy/PyCall.jl) and its dependencies and it will also use `pip` to install [GAlgebra](https://github.com/pygae/galgebra) if you haven't. If you wish to use a version other than the latest released version of GAlgebra that will be installed by `deps/build.jl`, you can install that via pip before/after the installation of `GAlgebra.jl`, e.g. `pip install -e <your local path to GAlgebra>` or `pip install https://github.com/pygae/galgebra/archive/master.zip`.

Now you may run GAlgebra.jl tests in Julia **Pkg REPL mode**:

Expand Down
36 changes: 0 additions & 36 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,4 @@ Modules = [GAlgebra]
Pages = ["mv.jl"]
```

```@docs
Base.:+(::Mv,::Mv)
Base.:-(::Mv,::Mv)
Base.:*(::Mv,::Mv)
Base.:/(::Mv,::Mv)
Base.:(==)(::Mv,::Mv)
GAlgebra.:≠(::Mv,::Mv)
GAlgebra.:∧(::Mv,::Mv)
GAlgebra.:⋅(::Mv,::Mv)
GAlgebra.:⨼(::Mv,::Mv)
GAlgebra.:⨽(::Mv,::Mv)
GAlgebra.:⊠(::Mv,::Mv)
GAlgebra.:⊙(::Mv,::Mv)
GAlgebra.:×(::Mv,::Mv)
GAlgebra.:⊛(::Mv,::Mv)
Base.:-(::Mv)
GAlgebra.norm(::Mv)
Base.inv(::Mv)
Base.:~(::Mv)
Base.adjoint(::Mv)
GAlgebra.involute(::Mv)
Base.conj(::Mv)
GAlgebra.proj(::Mv,::Mv)
GAlgebra.refl(::Mv,::Mv)
GAlgebra.rot(::Mv,::Mv)
Base.exp(::Mv)
GAlgebra.scalar(::Mv)
GAlgebra.even(::Mv)
GAlgebra.odd(::Mv)
```

0 comments on commit 44caa2c

Please sign in to comment.