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

Improve documentation for documentation module. #5449

Closed
carltongibson opened this issue Sep 25, 2017 · 1 comment
Closed

Improve documentation for documentation module. #5449

carltongibson opened this issue Sep 25, 2017 · 1 comment

Comments

@carltongibson
Copy link
Collaborator

In preparing #5448 I noted that documentation.py is essentially undocumented. There is a basic usage example for include_docs_urls in the Documenting your API topic page, but that's it.

We need documentation for the three functions:

  • include_docs_urls
  • get_schemajs_view
  • get_docs_view

This would help users wanting to customise the defaults here.

@carltongibson
Copy link
Collaborator Author

Duplicate of #4980

@carltongibson carltongibson marked this as a duplicate of #4980 Sep 28, 2017
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

1 participant