Hello,
i've a problem (probably it's a PEBCAK :D). but i can't solve it.
I'm trying to document a set of methods i wrote.
i use the automodule
.. automodule:: api
:members:
now, most of these methods are annotated with functions that i created,
which is from another project linked into the main project.
the documentation it works only for methods that are NOT annotated with my
annotation
for example:
@app.route('/%s/users/current' % APP_TRAINEE, methods=('GET',))
@user_required
def trainee_profile(req):
does not work, while for
@app.route("/%s/auth/<provider>/<token>" % APP_TRAINEE, methods=('GET',))
def auth(req, provider, token):
it works.
where's the problem? is the annotation not found?
Another question.
- can the doc automatically understand the @user_required and add to the
description a specific text, such as "This function requires an user"
basically adding automatically some text depending on the annotation..
if someone wants to see the code https://github.com/gymcentral/gymcentral
(the api.py is the file)
while the result is here: http://gc-api-test.appspot.com/docs/docs/api.html
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
