Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Crosslinks to poset catalog, add documentation of sage.geometry.polyhedron.base* and combinatorial_polyhedron #25675

Closed
jm58660 mannequin opened this issue Jun 27, 2018 · 65 comments

Comments

@jm58660
Copy link
Mannequin

jm58660 mannequin commented Jun 27, 2018

Add a mention about GrowthDiagram.rules.Sylvester().P_graph(5), polytopes.tetrahedron().face_lattice() etc. to poset catalog.

Repair the documentation of polyhedra damaged in #32651.

Add documentation of combinatorial polyhedra.

Depends on #34167

CC: @slel @jhpalmieri @kwankyu @kliem @jplab @yuan-zhou

Component: documentation

Author: Frédéric Chapoton, Matthias Koeppe, John Palmieri

Branch/Commit: 3082afe

Reviewer: John Palmieri, Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/25675

@jm58660 jm58660 mannequin added this to the sage-8.3 milestone Jun 27, 2018
@jm58660 jm58660 mannequin added c: documentation labels Jun 27, 2018
@fchapoton
Copy link
Contributor

Commit: cfe4512

@fchapoton
Copy link
Contributor

Branch: u/chapoton/25675

@fchapoton
Copy link
Contributor

New commits:

cfe4512some more links in catalog of posets

@mkoeppe
Copy link
Contributor

mkoeppe commented Dec 18, 2021

comment:3

Stalled in needs_review or needs_info; likely won't make it into Sage 9.5.

@mkoeppe mkoeppe modified the milestones: sage-9.5, sage-9.6 Dec 18, 2021
@slel
Copy link
Member

slel commented Mar 1, 2022

Author: Frédéric Chapoton

@orlitzky
Copy link
Contributor

comment:5

Do the new references show up as links for you? After merging the branch and doing sage -b; sage -docbuild reference/combinat html they both appear as the unlinked string face_lattice() for me. But I usually don't build the docs anymore so I don't know if that's supposed to be sufficient.

@mkoeppe mkoeppe modified the milestones: sage-9.6, sage-9.7 May 3, 2022
@jhpalmieri
Copy link
Member

comment:8

I think the issue with comment:5 is that the cited instances of face_lattice don't currently appear in the reference manual, so there is nothing for them to link to. I don't know if this would be a good idea, and it probably belongs on another ticket if so, but we could add a bunch of files to the reference manual, in the style of the matrix base classes:

diff --git a/src/doc/en/reference/discrete_geometry/index.rst b/src/doc/en/reference/discrete_geometry/index.rst
index a5d9663c5d..d84e72b481 100644
--- a/src/doc/en/reference/discrete_geometry/index.rst
+++ b/src/doc/en/reference/discrete_geometry/index.rst
@@ -76,6 +76,14 @@ Base classes for polyhedra
 .. toctree::
    :maxdepth: 1
 
+   sage/geometry/polyhedron/base0
+   sage/geometry/polyhedron/base1
+   sage/geometry/polyhedron/base2
+   sage/geometry/polyhedron/base3
+   sage/geometry/polyhedron/base4
+   sage/geometry/polyhedron/base5
+   sage/geometry/polyhedron/base6
+   sage/geometry/polyhedron/base7
    sage/geometry/polyhedron/base
    sage/geometry/polyhedron/base_QQ
    sage/geometry/polyhedron/base_ZZ

and also add a section on Combinatorial Polyhedra, to include various files from geometry/polyhedron/combinatorial_polyhedron. I don't know anything about this code or why it isn't currently included in the reference manual.

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

comment:10

Let's fix this here on the ticket, looks like we forgot to add them in #32651.

@mkoeppe mkoeppe changed the title Crosslinks to poset catalog Crosslinks to poset catalog, restore documentation of sage.geometry.polyhedron.base* Jul 16, 2022
@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

Changed branch from u/chapoton/25675 to u/mkoeppe/25675

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

comment:14

Replying to @jhpalmieri:

we could add a bunch of files to the reference manual, in the style of the matrix base classes

I've pushed this change to the ticket


New commits:

1a1efcfsome more links in catalog of posets
69dd9f2src/doc/en/reference/discrete_geometry/index.rst: Add base0 to base7

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

Changed commit from cfe4512 to 69dd9f2

@jhpalmieri
Copy link
Member

comment:15

I propose these changes. It's interesting that #30448 didn't catch the markup error in face_iterator.pyx.

@jhpalmieri
Copy link
Member

Changed branch from u/mkoeppe/25675 to u/jhpalmieri/25675

@jhpalmieri
Copy link
Member

comment:17

Now both face_lattice links work for me.


New commits:

0636b81some more links in catalog of posets
a499c75Merge branch 'u/mkoeppe/25675' of trac.sagemath.org:sage into t/25675/25675
bf4c354trac 25675: correct link to base4 for face_lattice, and add

@vbraun
Copy link
Member

vbraun commented Aug 8, 2022

comment:45
[sagemath_doc_pdf-none] ! Package inputenc Error: Unicode character ⊃ (U+2283)
[sagemath_doc_pdf-none] (inputenc)                not set up for use with LaTeX.
[sagemath_doc_pdf-none] 
[sagemath_doc_pdf-none] See the inputenc package documentation for explanation.
[sagemath_doc_pdf-none] Type  H <return>  for immediate help.
[sagemath_doc_pdf-none]  ...                                              
[sagemath_doc_pdf-none]                                                   
[sagemath_doc_pdf-none] l.26189 ... `P` ⊃ ``one\PYGZus{}face`` ⊃ `F`.}
[sagemath_doc_pdf-none]                                                   
[sagemath_doc_pdf-none] ? 
[sagemath_doc_pdf-none] ! Emergency stop.

@mkoeppe
Copy link
Contributor

mkoeppe commented Aug 8, 2022

comment:46

I'm rewriting the docstring where this is coming from

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 8, 2022

Changed commit from 0d3b5ef to 858e982

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 8, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

fb998d7Merge tag '9.7.beta8' into t/25675/25675
858e982src/sage/geometry/polyhedron/combinatorial_polyhedron/face_iterator.pyx: Reformat algorithm, avoid unicode symbols

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 9, 2022

Changed commit from 858e982 to 5021604

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 9, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

5021604src/sage/geometry/polyhedron/combinatorial_polyhedron/face_iterator.pyx: Reformat algorithm, avoid unicode symbols (fixup)

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 9, 2022

Changed commit from 5021604 to feec89b

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 9, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

feec89bsrc/sage/geometry/polyhedron/combinatorial_polyhedron/face_iterator.pyx: Reformat algorithm, avoid unicode symbols (fixup 2)

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 9, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

3082afesrc/sage/geometry/polyhedron/combinatorial_polyhedron/face_iterator.pyx: Reformat algorithm, avoid unicode symbols (fixup 3)

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 9, 2022

Changed commit from feec89b to 3082afe

@mkoeppe
Copy link
Contributor

mkoeppe commented Aug 9, 2022

comment:51

Now it's OK with html and pdf

@jhpalmieri
Copy link
Member

comment:53

It looks good to me, thanks for the revisions.

@mkoeppe
Copy link
Contributor

mkoeppe commented Aug 10, 2022

comment:54

Thanks!

@vbraun
Copy link
Member

vbraun commented Aug 29, 2022

Changed branch from u/mkoeppe/25675 to 3082afe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants