Создать документацию Godoc для всего проекта? - PullRequest
Новая
       23

Создать документацию Godoc для всего проекта?

0 голосов
/ 02 ноября 2018

Я боролся с Godoc и обнаружил, что «go doc» больше подходит для предоставления помощи по использованию из командной строки, например: 

go doc -cmd -u

перечисляет комментарий пакета и любые функции (или другие объекты) 

go doc *function*

затем показывает документацию для отдельной функции (или другого объекта)

Кажется, есть связанный инструмент под названием godoc . Godoc также, похоже, генерирует HTML для каждого пакета и функции. Э.Г. 

godoc -html hello

Генерирует html, содержащий комментарий пакета только для stdout

godoc - это действительно запутанное имя, учитывая, что у нас есть go doc !

Как создать статическую документацию для всего проекта?

Это похоже на Godoc, создайте html для всего пакета , который мог быть неверно истолкован как запрос документации о пакетах, а не проектах. Мне нужен шаг сборки, который я могу использовать в проекте, который в принципе может содержать много пакетов и приложений.

Ответы [ 2 ]

0 голосов
/ 14 января 2019

существует ли канонический способ создания документации для автономного использования, даже с использованием godoc?

Перейти 1.12 (февраль 2019) яснее об этом:

godoc и go doc

В Go 1.12 godoc больше не имеет интерфейса командной строки и является только веб-сервером.
Пользователи должны использовать go doc для вывода справки из командной строки.

go doc теперь поддерживает флаг -all , который заставит его печатать все экспортированные API и их документацию, как это делала командная строка godoc.

cmd/doc: добавьте флаг -all, чтобы распечатать всю документацию для пакета

В отличие от старого godoc, вам нужен флаг -u, чтобы увидеть не экспортированные символы.
Это похоже на правильное поведение: оно соответствует.

0 голосов
/ 09 января 2019

Я изо всех сил пытался сделать это, и, наконец, вещь, которая работала для меня, это

  1. убедитесь, что у вас установлен "wget" (я использую Mac, поэтому пришлось установить его с помощью x-кода)
  2. Войдите в систему как пользователь root и измените файл с именем «robots.txt», чтобы удалить строку «Disallow: /», поскольку это предотвращает рекурсивное скачивание сайта с помощью wget. Файл "robots.txt" должен находиться в пути $ GOROOT.

  3. откройте cmd и запустите сервер godocs с помощью следующей команды

    godoc -http =: 6060

У меня настроен локальный путь к этому порту. 4. Откройте другой cmd и выполните приведенную ниже команду.

wget -r -np -N -E -p -k http://localhost:6060/pkg/myproject

вы можете указать путь к проекту для загрузки html-документов для всего проекта.

...