2012-11-23 12 views

Odpowiedz

29

Prosta dokumentacja HTML można wytwarzać, na przykład:

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

Nieco lepsza forma może być wytwarzany przez:

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

(mam serwer godoc działa pod adresem: 6060 i I nie jestem pewien, czy jest to warunek wstępny).

HTML prawdopodobnie wyglądałby lepiej, gdyby był połączony z oryginalnymi stylami CSS znalezionymi w repozytorium Go, dostosowując wygenerowane pliki HTML, aby prawidłowo się do nich odnosić.

+1

Nie warunkiem prawdziwego serwera i 'godoc -url„/ pkg/pojemnik/kupie /”> page.html' wystarczą – FiloSottile

+0

Jest otwarty do żądania zmiany dodaj obsługę generowania statycznej strony https://github.com/golang/go/issues/2381#issuecomment-342043987 – dnephin

11

Może to nie odpowiedzieć bezpośrednio na twoje pytanie, ale jeśli planujesz otworzyć źródło projektu, nie musisz generować kodu HTML ręcznie. Upewnij się, że masz poprawnie wstawione komentarze do kodu źródłowego i użyj godoc.org (http://godoc.org/-/about), aby go obsłużyć.

Wyświetla dokumentację pakietów Go na Bitbucket, Github, Launchpad i Google Project Hosting.

Sprawdź to na przykład: http://godoc.org/code.google.com/p/go.crypto/ssh

+1

Dzięki, byłem zaskoczony, gdy znalazłem dokument dotyczący pakietu na godoc! – pltvs

Powiązane problemy