#12991: Don't doctest autogenerated rst files
-------------------------------+--------------------------------------------
Reporter: jhpalmieri | Owner: mvngu
Type: enhancement | Status: new
Priority: minor | Milestone: sage-5.1
Component: doctest | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: | Merged in:
Dependencies: | Stopgaps:
-------------------------------+--------------------------------------------
Description changed by kini:
Old description:
> When we build the Sage documentation, we create lots of files which look
> like the following
> (`SAGE_ROOT/devel/sage/doc/en/reference/sage/algebras/free_algebra_quotient_element.rst`):
> {{{
> .. _sage.algebras.free_algebra_quotient_element:
>
> Free algebra quotient elements
> ==============================
>
> .. This file has been autogenerated.
>
> .. automodule:: sage.algebras.free_algebra_quotient_element
> :members:
> :undoc-members:
> :show-inheritance:
> }}}
> When we run `make ptestlong`, these files get doctested. I don't think
> there is a good reason for this: we should skip these files when
> doctesting. There are two ways of doing this: patch the doctesting
> scripts to skip files containing `\n.. This file has been
> autogenerated.\n', or write `.. nodoctest` as the first line of each of
> these files. The attached patch does the second of these (a patch to do
> the first is given in a comment below).
New description:
When we build the Sage documentation, we create lots of files which look
like the following
(`SAGE_ROOT/devel/sage/doc/en/reference/sage/algebras/free_algebra_quotient_element.rst`):
{{{
.. _sage.algebras.free_algebra_quotient_element:
Free algebra quotient elements
==============================
.. This file has been autogenerated.
.. automodule:: sage.algebras.free_algebra_quotient_element
:members:
:undoc-members:
:show-inheritance:
}}}
When we run `make ptestlong`, these files get doctested. I don't think
there is a good reason for this: we should skip these files when
doctesting. There are two ways of doing this: patch the doctesting scripts
to skip files containing `\n.. This file has been autogenerated.\n`, or
write `.. nodoctest` as the first line of each of these files. The
attached patch does the second of these (a patch to do the first is given
in a comment below).
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12991#comment:1>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
