Как я могу сгенерировать HTML-документы с помощью `godoc`?

Я написал небольшую программу go, и я хочу создавать автономные HTML-документы из исходного кода, которые можно просматривать без сервера godoc. Но я не могу найти способ добиться этого. если кто-нибудь может мне помочь, я буду признателен.

Ответ 1

Простую HTML-документацию можно получить, например:

$ godoc -html container/heap Interface > page.html

Немного лучшая форма может быть произведена:

$ godoc -url "http://localhost:6060/pkg/container/heap/" > page.html

(У меня есть сервер godoc, работающий на: 6060, и я не уверен, что это предпосылка).

HTML, вероятно, будет выглядеть лучше, если в сочетании с оригинальными стилями CSS, найденными в репозитории Go, путем настройки готовых HTML файлов, чтобы правильно ссылаться на него.

Ответ 2

Это не может напрямую ответить на ваш вопрос, но если вы планируете открывать исходный код своего проекта, вам действительно не нужно создавать HTML вручную. Просто убедитесь, что у вас есть комментарии, правильно вставленные в исходный код, и используйте godoc.org(http://godoc.org/-/about) для его обработки.

Он отображает документацию для пакетов Go на Bitbucket, Github, Launchpad и Google Project Hosting.

Проверьте это, например: http://godoc.org/code.google.com/p/go.crypto/ssh

Ответ 3

Запустите сервер и получите его с помощью wget

godoc -http=:6060

затем дождитесь его запуска ("контейнер/куча/" с вашим приложением):

wget -p -k http://localhost:6060/pkg/container/heap/

Для загрузки всех документов я использую следующее:

wget -m -k -q -erobots=off --no-host-directories --no-use-server-timestamps http://localhost:6060