Extended functionality and documentation

.github/workflows/CI.yml

@@ -42,3 +42,37 @@ jobs:
         with:
           file: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    name: "Documentation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@latest
+      - name: "Install package"
+        run: |
+          julia --project=docs --color=yes -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+            #- name: "Run doctests"
+            #run: |
+            #julia --project=docs --color=yes test/doctest.jl
+      - name: "Deploy documentation"
+        run: julia --project=docs --color=yes docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

Project.toml

@@ -11,8 +11,8 @@ Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Polymake = "d720cf60-89b5-51f5-aff5-213f193123e7"
 
 [compat]
-CapAndHomalg = "1.1.7"
-GAP = "0.6.1"
+CapAndHomalg = "1.1.8"
+GAP = "0.6.2"
 Oscar = "0.6"
 Polymake = "0.5"
 julia = "1.4"

docs/.gitignore

@@ -0,0 +1 @@
+build/

docs/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+JToric = "9bfa4af0-0a41-40a3-86ae-7e8f6cc9e7ab"
+
+[compat]
+Documenter = "^0.25.0"

docs/make.jl

@@ -0,0 +1,4 @@
+push!(LOAD_PATH,"../src/")
+using Documenter, JToric
+
+makedocs(sitename="JToric -- Toric Geometry in Julia")

docs/mkdocs.yml

@@ -0,0 +1,19 @@
+site_name:           JToric.jl
+repo_url:            https://github.com/oscar-system/JToric.jl
+site_description:    JToric
+site_author:         Martin Bies
+
+theme:               readthedocs
+
+pages:
+
+markdown_extensions:
+  - extra
+  - tables
+  - fenced_code
+  - mdx_math:
+      enable_dollar_delimiter: True
+
+docs_dir: 'build'
+
+extra_javascript: ['mathjaxhelper.js', 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-AMS_HTML']

docs/src/index.md

@@ -0,0 +1,122 @@
+# JToric -- toric geometry in Julia
+
+```@contents
+```
+
+```@meta
+CurrentModule = JToric
+```
+
+## Goal
+
+The goal of the package `JToric` is to make computations on toric geometry accessible in the [OSCAR computer algebra system](https://oscar.computeralgebra.de/). As such, we follow [the book](https://www.ams.org/publications/authors/books/postpub/gsm-124) `Toric Varieties` by `David A. Cox`, `John B. Little` and `Henry K. Schenck`]. Currently, this project is work-in-progress. Our goal is to ensure that one can perform all computations of `Appendix B`.
+
+
+### Generalities
+
+```@docs
+version
+```
+
+## Toric Varieties
+
+### Constructors
+
+```@docs
+NormalToricVariety
+projective_space
+```
+
+### Conversion among GAP and Polymake toric varieties
+
+```@docs
+ntv_gap2polymake
+ntv_polymake2gap
+```
+
+### Properties of toric varieties
+
+```@docs
+is_normal_variety
+is_affine
+is_projective
+is_smooth
+is_complete
+has_torusfactor
+is_orbifold
+is_simplicial
+is_isomorphic_to_projective_space
+is_direct_product_of_projective_spaces
+```
+
+### Attributes of toric varieties
+
+```@docs
+affine_open_covering
+cox_ring
+list_of_variables_of_cox_ring
+class_group
+torus_invariant_divisor_group
+map_from_character_to_principal_divisor
+map_from_weil_divisors_to_class_group
+dim
+dimension_of_torusfactor
+coordinate_ring_of_torus
+list_of_variables_of_coordinate_ring_of_torus
+is_product_of
+factors
+character_lattice
+torus_invariant_prime_divisors
+irrelevant_ideal
+stanley_reisner_ideal
+morphism_from_cox_variety
+cox_variety
+fan_of_variety
+fan
+cartier_torus_invariant_divisor_group
+picard_group
+name_of_variety
+zariski_cotangent_sheaf
+cotangent_sheaf
+euler_characteristic
+weil_divisors_of_variety
+zariski_cotangent_sheaf_via_euler_sequence
+zariski_cotangent_sheaf_via_poincare_residue_map
+```
+
+
+### Methods of toric varieties
+
+```@docs
+set_name_of_variety
+coordinate_ring_of_torus( v::NormalToricVariety, names::Vector{String} )
+cox_ring( v::NormalToricVariety, name::String )
+Base.:*( v::NormalToricVariety, w::NormalToricVariety )
+character_to_rational_function( l::Vector{Int}, v::NormalToricVariety )
+blowup_on_ith_minimal_torus_orbit( v::NormalToricVariety, i::Int )
+ith_betti_number( v::NormalToricVariety, i::Int )
+nr_of_q_rational_points( v::NormalToricVariety, i::Int )
+```
+
+
+## Toric Divisors
+
+### Constructors
+
+```@docs
+create_divisor
+divisor_of_character
+divisor_of_class
+```
+
+### Properties of toric divisors
+
+```@docs
+is_cartier
+is_principal
+is_primedivisor
+is_basepoint_free
+is_ample
+is_very_ample
+is_numerically_effective
+```