Как запустить godoc в каком-нибудь популярном репозитории go?

#go #documentation #godoc

#Вперед #Документация #godoc

Вопрос:

В новом godoc есть несколько приятных функций, таких как список вызывающих абонентов и т. Д. В любом случае у меня проблемы с его запуском, например:

 ➜  ~GOPATH git:(master) ✗ ls src/github.com/coreos/etcd/
CHANGELOG       DCO             Documentation   README.md       bench           build           contrib         error           fixtures        go_version.go   http            main.go         mod             scripts         store           tests
CONTRIBUTING.md Dockerfile      LICENSE         Vagrantfile     bin             config          discovery       etcd            foo             gopath          log             metrics         pkg             server          test.sh         third_party
➜  ~GOPATH git:(master) ✗ godoc github.com/coreos/etcd/discovery -http=:6060
No match found.

Кто-нибудь может сказать мне, как запустить его в некоторых популярных репозиториях go, таких как etcd, которые я использую выше?

1. Вы установили GOPATH? Для меня все в порядке.

2. Да, я выполнял команды из GOPATH.

3.Я вижу: -http=:6060 похоже, не работает при получении пакета. Либо укажите имя пакета, либо -http=:6060

Ответ №1:

Godoc имеет две основные функции:

Он отображает документацию для пакета
Он запускает веб-сервер, который вы можете просмотреть, чтобы просмотреть документацию по локальным пакетам

Здесь вы пытаетесь выполнить оба одновременно. Либо удалите -http=:6060 опцию просмотра документации пакета в консоли, либо удалите путь к пакету, чтобы запустить веб-сервер и выполнить поиск в вашем браузере.

1. Я попытался запустить с опцией http, но я получаю только локальную версию веб-сайта go….

2. Но список пакетов должен включать ваши локальные пакеты.

3. Хорошо, итак, я делаю что-то не так, поскольку у меня есть только документы std lib: (

Ответ №2:

Godoc может либо запускать документацию по вашему коду для создания выходных данных на терминале (запуск godoc без флагов -server или -http), либо может быть запущен как сервер с тегами -http /-server (и не принимает никаких других аргументов). Не может быть и того, и другого одновременно.

Если вы не видите свой код в пакетах, вам нужно запустить go install mypackage , например, если вы github.com/coreos/etcd/discovery клонировали, затем запустите go install github.com/coreos/etcd/discovery , и он должен появиться на странице документов go, выполняемой godoc -http=:port

Просто столкнулся с этой проблемой с моим кодом и не увидел никаких других ответов.

Ответ №3:

 godoc -http=:6060 amp;
go get github.com/coreos/etcd/discovery
open http://localhost:6060/pkg/github.com/coreos/etcd/discovery