django_docs

README

Package django-docs

Utility to query and search for django docs from the command-line. Written in Go.

Documentation

Index

• func ExtractDocs(docDir string) (docs map[SymbolID]DjangoDoc, errs []error)
• type DjangoDoc
• type SymbolID

Functions

func ExtractDocs

func ExtractDocs(docDir string) (docs map[SymbolID]DjangoDoc, errs []error)

Types

type DjangoDoc

type DjangoDoc struct {
	Symbol     SymbolID
	Body       string
	SourceFile string
	Start      int
	End        int
}

type SymbolID

type SymbolID string