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

PXD-2257 ⁃ fix sheepdog's sphinx documentation #209

Open
philloooo opened this issue Oct 30, 2018 · 0 comments
Open

PXD-2257 ⁃ fix sheepdog's sphinx documentation #209

philloooo opened this issue Oct 30, 2018 · 0 comments

Comments

@philloooo
Copy link
Contributor

Figure out if Sphinx can parse the format we use to document endpoints:

def get_new_endpoint_function(param1):
    """
    Detailled description of this endpoint

    Summary:
        A short summary of what this endpoint does

    Tags:
        program
        
    Args:
        param1 (str): description of the path parameter
    
    Query Args:
        param2 (str): description of the query parameter

    Responses:
        200: Success
        403: Unauthorized request
    """
    #################
    # function body #
    #################
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant