#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.7
Component: documentation | Keywords: sphinx, documentation, cython
inspection
Author: jsrn, Simon King | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Comment(by jsrn):
Replying to [comment:19 SimonKing]:
> Replying to [comment:18 SimonKing]:
> > Then, I bumped it up, and inserted a `raise RuntimeError` into the
first line of both methods. Nevertheless, the documentation builds as it
did before.
> >
> > So, I must conclude that neither version of `get_doc` is used to get
documentation.
>
> No, the reason for that behaviour is that apparently the documentation
is cached on disk. In other words, I had to delete the html file '''and'''
to touch the code from which the documentation was taken, '''and''' to do
"sage -b".
>
> After that preparation, things worked.
>
> My question to you: How can I completely wipe the cache?
Yeah, that's true. I guess it works as a lot of other build-stuff does by
only rebuilding something when the source files have changed; and I guess
in this case, the source files are the *py[x] files resulting from running
./sage -b. At least, I found no quicker way for rebuilding the
documentation of some file after changing sage_autodoc than what you did:
edit sage_autodoc, touch some file, sage -b, build documentation.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:21>
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.
