Skip to content

Improve documentation for documentation module.  #5449

@carltongibson

Description

@carltongibson

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy