Просмотр документации пакета локально в браузере - PullRequest
2 голосов
/ 28 мая 2019

Я хочу увидеть локально, как будет выглядеть моя документация к пакету.То есть я хочу видеть то же, что вы видите на godoc.org , но локально.

У меня есть простой пример папки локально, но я не могу ее получитьРабота.Он правильно выводит текстовую документацию:

~/code/go/gonotes (master) $ godoc .
PACKAGE DOCUMENTATION

package gonotes
    import "."


FUNCTIONS

func Blah()
    Here is header

    Blah is function being use to test:

    - go documentation
    - blah like things

    It is nice

Но если я запускаю godoc -http=:6060 и перехожу к http://localhost:6060/, я вижу, по сути, то же содержимое, которое вижу на домашней странице golang.com.http://localhost:6060/gonotes отображает

lstat $GOROOT/gonotes: no such file or directory

Я неправильно понимаю, как работает -http?Есть ли какой-нибудь способ предварительно просмотреть http-версию моих документов?

ОБНОВЛЕНИЕ

Мне удалось его отобразить, скопировав файлы в src/gonotes и запустив:

GOPATH=/Users/jonah/code/go/gonotes godoc -http=:6060

, чтобы фактические файлы были доступны на /Users/jonah/code/go/gonotes/src/gonotes.

Это побочный эффект - не показывать какие-либо библиотеки третьей части, установленные в моем по умолчанию GOPATH, поэтому я быЯ все еще хотел бы найти решение, которое просто позволяет мне добавить текущий каталог, как есть, без добавления src/curdir к нему, и при этом все равно показывать его.

1 Ответ

1 голос
/ 28 мая 2019

В GOPATH режиме

godoc -http будет обслуживать все доступные пакеты, включая стандартную библиотеку. Не беспокойтесь, ваши собственные пакеты среди них, просто посмотрите еще раз. В качестве ярлыка просто наберите http://localhost:6060/pkg/your/package.

В модульном режиме

GOPATH и модули взаимоисключающие , см. Go Modules не распознает файлы в GOPATH . Инструмент godoc не поддерживает модули, и его использование устарело (см. предупреждение об устаревании ), поэтому на данный момент, если вы хотите, чтобы ваши документы по пакетам локально находились в godoc, вам необходимо прибегнуть к размещению их источников в папке src.

«Обходной путь» для просмотра документов модулей:

  • Поместите репо в папку типа /some/folder/src

  • Начать годок с godoc -goroot=/some/folder -http=:6060

См. Связанную проблему: поддержка Go модулей

Также обсуждение в группах: Является ли инструмент gooc 1.11 godoc «модульно-ориентированным»?

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...