Opened 6 years ago

Closed 6 years ago

#16641 closed defect (fixed)

Add qepcad to documentation

Reported by: jondo Owned by:
Priority: major Milestone: sage-6.4
Component: documentation Keywords: qepcad
Cc: Merged in:
Authors: Frédéric Chapoton Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: ef4de14 (Commits) Commit: ef4de142a8fe5536e08f7fc2bee5e7839829c574
Dependencies: Stopgaps:

Change History (16)

comment:1 Changed 6 years ago by chapoton

  • Branch set to u/chapoton/16641
  • Commit set to 2fa3023d5d569b5320ebe920a7961c99588bf208

Here is a git branch adding qepcad to the documentation.


New commits:

2fa3023trac #16641 qepcad in interfaces doc

comment:2 Changed 6 years ago by chapoton

  • Keywords qepcad added

comment:3 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4

comment:4 Changed 6 years ago by jdemeyer

  • Summary changed from Online Python module index should list sage.interfaces.qepcad to Add qepcad to documentation

author name please...

comment:5 follow-up: Changed 6 years ago by chapoton

  • Authors set to Frédéric Chapoton

I am not sure what I did is what was required. Do you think so ?

comment:6 in reply to: ↑ 5 Changed 6 years ago by jdemeyer

Replying to chapoton:

I am not sure what I did is what was required.

Yes, but unfortunately, you also need to fix the documentation such that it actually compiles:

[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:8: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:284: WARNING: Inline interpreted text or phrase reference start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:292: WARNING: Inline interpreted text or phrase reference start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:310: WARNING: Inline interpreted text or phrase reference start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:330: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:348: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:477: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.QepcadCell.set_truth:4: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad:3: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad:120: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad:120: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.and_:1: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.formula:8: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.iff:1: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.implies:1: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.not_:1: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.or_:1: WARNING: Inline literal start-string without end-string.
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.X:8: ERROR: Unknown target name: "not".
[interface] /usr/local/src/sage-git/local/lib/python2.7/site-packages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.exactly_k:8: ERROR: Unknown target name: "not".

comment:7 Changed 6 years ago by git

  • Commit changed from 2fa3023d5d569b5320ebe920a7961c99588bf208 to af66e838e51b7eb68c952161cddfb0157092c32b

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

e4fc6d8Merge branch 'u/chapoton/16641' of ssh://trac.sagemath.org:22/sage into 16641
af66e83trac #16641 correcting doc syntax

comment:8 Changed 6 years ago by chapoton

  • Status changed from new to needs_review

comment:9 Changed 6 years ago by jdemeyer

  • Reviewers set to Jeroen Demeyer
  • Status changed from needs_review to positive_review

The documentation still doesn't look totally clean, but at least it works.

comment:10 Changed 6 years ago by vbraun

  • Status changed from positive_review to needs_work

PDF docs don't build:

! Missing $ inserted.
<inserted text> 
                $
l.11070 $\mbox{_root_}
                      k \quad P(\bar x, y)$ refers to a particular zero of
? ]
! Emergency stop.
<inserted text> 
                $
l.11070 $\mbox{_root_}
                      k \quad P(\bar x, y)$ refers to a particular zero of
!  ==> Fatal error occurred, no output PDF file produced!
Transcript written on interfaces.log.

comment:11 Changed 6 years ago by git

  • Commit changed from af66e838e51b7eb68c952161cddfb0157092c32b to beee140611a747394285f076c4ba8eda4d893c9c

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

beee140trac #16641 more work on doc, trying to get pdf building

comment:12 Changed 6 years ago by git

  • Commit changed from beee140611a747394285f076c4ba8eda4d893c9c to adcec43f38a9201c1fb30086c509f047ee1a38eb

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

adcec43trac #16641 put doc of qepcad into 80 rows format

comment:13 Changed 6 years ago by chapoton

  • Status changed from needs_work to needs_review

I think I have managed to make the pdf compilation work. The doc is morever a little bit nicer than before.

comment:14 Changed 6 years ago by jdemeyer

  • Branch changed from u/chapoton/16641 to u/jdemeyer/ticket/16641
  • Created changed from 07/10/14 10:39:37 to 07/10/14 10:39:37
  • Modified changed from 09/06/14 14:24:50 to 09/06/14 14:24:50

comment:15 Changed 6 years ago by jdemeyer

  • Commit changed from adcec43f38a9201c1fb30086c509f047ee1a38eb to ef4de142a8fe5536e08f7fc2bee5e7839829c574
  • Status changed from needs_review to positive_review

Positive review. I have made a trivial change to use new-style doctest continuations (....: instead of ...).


New commits:

ef4de14Use new doctest continuation

comment:16 Changed 6 years ago by vbraun

  • Branch changed from u/jdemeyer/ticket/16641 to ef4de142a8fe5536e08f7fc2bee5e7839829c574
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.