Opened 8 years ago
Closed 8 years ago
#16641 closed defect (fixed)
Add qepcad to documentation
Reported by:  Robert Pollak  Owned by:  

Priority:  major  Milestone:  sage6.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, GitHub, GitLab)  Commit:  ef4de142a8fe5536e08f7fc2bee5e7839829c574 
Dependencies:  Stopgaps: 
Description
Change History (16)
comment:1 Changed 8 years ago by
Branch:  → u/chapoton/16641 

Commit:  → 2fa3023d5d569b5320ebe920a7961c99588bf208 
comment:2 Changed 8 years ago by
Keywords:  qepcad added 

comment:3 Changed 8 years ago by
Milestone:  sage6.3 → sage6.4 

comment:4 Changed 8 years ago by
Summary:  Online Python module index should list sage.interfaces.qepcad → Add qepcad to documentation 

author name please...
comment:5 followup: 6 Changed 8 years ago by
Authors:  → Frédéric Chapoton 

I am not sure what I did is what was required. Do you think so ?
comment:6 Changed 8 years ago by
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/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:8: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:81: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:284: WARNING: Inline interpreted text or phrase reference startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:292: WARNING: Inline interpreted text or phrase reference startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:310: WARNING: Inline interpreted text or phrase reference startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:330: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:348: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad:477: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.QepcadCell.set_truth:4: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad:3: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad:120: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad:120: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.and_:1: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.formula:8: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.iff:1: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.implies:1: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.not_:1: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.or_:1: WARNING: Inline literal startstring without endstring. [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.X:8: ERROR: Unknown target name: "not". [interface] /usr/local/src/sagegit/local/lib/python2.7/sitepackages/sage/interfaces/qepcad.py:docstring of sage.interfaces.qepcad.qepcad_formula_factory.exactly_k:8: ERROR: Unknown target name: "not".
comment:7 Changed 8 years ago by
Commit:  2fa3023d5d569b5320ebe920a7961c99588bf208 → af66e838e51b7eb68c952161cddfb0157092c32b 

comment:8 Changed 8 years ago by
Status:  new → needs_review 

comment:9 Changed 8 years ago by
Reviewers:  → Jeroen Demeyer 

Status:  needs_review → positive_review 
The documentation still doesn't look totally clean, but at least it works.
comment:10 Changed 8 years ago by
Status:  positive_review → 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 8 years ago by
Commit:  af66e838e51b7eb68c952161cddfb0157092c32b → beee140611a747394285f076c4ba8eda4d893c9c 

Branch pushed to git repo; I updated commit sha1. New commits:
beee140  trac #16641 more work on doc, trying to get pdf building

comment:12 Changed 8 years ago by
Commit:  beee140611a747394285f076c4ba8eda4d893c9c → adcec43f38a9201c1fb30086c509f047ee1a38eb 

Branch pushed to git repo; I updated commit sha1. New commits:
adcec43  trac #16641 put doc of qepcad into 80 rows format

comment:13 Changed 8 years ago by
Status:  needs_work → 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 8 years ago by
Branch:  u/chapoton/16641 → u/jdemeyer/ticket/16641 

Created:  Jul 10, 2014, 10:39:37 AM → Jul 10, 2014, 10:39:37 AM 
Modified:  Sep 6, 2014, 2:24:50 PM → Sep 6, 2014, 2:24:50 PM 
comment:15 Changed 8 years ago by
Commit:  adcec43f38a9201c1fb30086c509f047ee1a38eb → ef4de142a8fe5536e08f7fc2bee5e7839829c574 

Status:  needs_review → positive_review 
Positive review. I have made a trivial change to use newstyle doctest continuations (....:
instead of ...
).
New commits:
ef4de14  Use new doctest continuation

comment:16 Changed 8 years ago by
Branch:  u/jdemeyer/ticket/16641 → ef4de142a8fe5536e08f7fc2bee5e7839829c574 

Resolution:  → fixed 
Status:  positive_review → closed 
Here is a git branch adding qepcad to the documentation.
New commits:
trac #16641 qepcad in interfaces doc