Игнорировать внешние зависимости и стандартную библиотеку в выводе `godoc` - PullRequest
0 голосов
/ 02 марта 2020

У меня есть проект Go, который использует Go Модули. Я хотел бы использовать godoc для генерации документации для пакетов этого проекта. В настоящее время я использую:

godoc -http=":6060"

Это, конечно, генерирует документацию для проекта, но также генерирует документацию стандартной библиотеки и импортированных зависимостей.

Есть ли способ игнорировать это? Они чувствуют себя лишними в лучшем случае. Если их невозможно игнорировать, есть ли способ использовать godoc или go doc для генерации документации в формате HTML для пакетов проекта?

1 Ответ

0 голосов
/ 02 марта 2020

Это опции, доступные для godoc:

$ godoc --help
usage: godoc package [name ...]
    godoc -http=:6060
  -all
        include unexported identifiers in command-line mode
  -analysis string
        comma-separated list of analyses to perform (supported: type, pointer). See http://golang.org/lib/godoc/analysis/help.html
  -ex
        show examples in command line mode
  -goroot string
        Go root directory (default "/usr/local/go")
  -html
        print HTML in command-line mode
  -http string
        HTTP service address (e.g., ':6060')
  -httptest.serve string
        if non-empty, httptest.NewServer serves on this address and blocks
  -index
        enable search index
  -index_files string
        glob pattern specifying index files; if not empty, the index is read from these files in sorted order
  -index_interval duration
        interval of indexing; 0 for default (5m), negative to only index once at startup
  -index_throttle float
        index throttle value; 0.0 = no time allocated, 1.0 = full throttle (default 0.75)
  -links
        link identifiers to their declarations (default true)
  -maxresults int
        maximum number of full text search results shown (default 10000)
  -notes string
        regular expression matching note markers to show (default "BUG")
  -play
        enable playground in web interface
  -q    arguments are considered search queries
  -server string
        webserver address for command line searches
  -src
        print (exported) source in command-line mode
  -tabwidth int
        tab width (default 4)
  -templates string
        load templates/JS/CSS from disk in this directory
  -timestamps
        show timestamps with directory listings
  -url string
        print HTML for named URL
  -v    verbose mode
  -write_index
        write index to a file; the file name must be specified with -index_files
  -zip string
        zip file providing the file system to serve; disabled if empty
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...