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

Add qepcad to documentation #16641

Closed
jondo opened this issue Jul 10, 2014 · 22 comments
Closed

Add qepcad to documentation #16641

jondo opened this issue Jul 10, 2014 · 22 comments

Comments

@jondo
Copy link

jondo commented Jul 10, 2014

at http://sagemath.org/doc/py-modindex.html

Component: documentation

Keywords: qepcad

Author: Frédéric Chapoton

Branch/Commit: ef4de14

Reviewer: Jeroen Demeyer

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

@jondo jondo added this to the sage-6.3 milestone Jul 10, 2014
@fchapoton
Copy link
Contributor

Commit: 2fa3023

@fchapoton
Copy link
Contributor

comment:1

Here is a git branch adding qepcad to the documentation.


New commits:

2fa3023trac #16641 qepcad in interfaces doc

@fchapoton
Copy link
Contributor

Branch: u/chapoton/16641

@fchapoton
Copy link
Contributor

Changed keywords from none to qepcad

@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.3, sage-6.4 Aug 10, 2014
@jdemeyer
Copy link

comment:4

author name please...

@jdemeyer jdemeyer changed the title Online Python module index should list sage.interfaces.qepcad Add qepcad to documentation Aug 31, 2014
@fchapoton
Copy link
Contributor

comment:5

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

@fchapoton
Copy link
Contributor

Author: Frédéric Chapoton

@jdemeyer
Copy link

comment:6

Replying to @fchapoton:

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".

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 31, 2014

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 31, 2014

Changed commit from 2fa3023 to af66e83

@jdemeyer
Copy link

jdemeyer commented Sep 2, 2014

comment:9

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

@jdemeyer
Copy link

jdemeyer commented Sep 2, 2014

Reviewer: Jeroen Demeyer

@vbraun
Copy link
Member

vbraun commented Sep 5, 2014

comment:10

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.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Sep 6, 2014

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

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Sep 6, 2014

Changed commit from af66e83 to beee140

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Sep 6, 2014

Changed commit from beee140 to adcec43

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Sep 6, 2014

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

adcec43trac #16641 put doc of qepcad into 80 rows format

@fchapoton
Copy link
Contributor

comment:13

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

@jdemeyer
Copy link

jdemeyer commented Sep 7, 2014

Changed branch from u/chapoton/16641 to u/jdemeyer/ticket/16641

@jdemeyer
Copy link

jdemeyer commented Sep 7, 2014

comment:15

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


New commits:

ef4de14Use new doctest continuation

@jdemeyer
Copy link

jdemeyer commented Sep 7, 2014

Changed commit from adcec43 to ef4de14

@vbraun
Copy link
Member

vbraun commented Sep 8, 2014

Changed branch from u/jdemeyer/ticket/16641 to ef4de14

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

4 participants