Consulter la documentation du paquet localement dans un navigateur

Question

Je veux voir localement à quoi ressemblera la documentation de mon paquet. En d'autres termes, je veux voir le même genre de chose que ce que l'on voit sur godoc.org mais localement.

J'ai un dossier d'exemple simple en local, mais je n'arrive pas à le faire fonctionner. Il produit correctement une documentation textuelle :

~/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

Mais si je cours godoc -http=:6060 et naviguez jusqu'à http://localhost:6060/ Je vois essentiellement le même contenu que sur la page d'accueil de golang.com. http://localhost:6060/gonotes affichages

lstat $GOROOT/gonotes: no such file or directory

Ai-je mal compris comment le -http fonctionne ? Existe-t-il un moyen de prévisualiser localement la version http de mes documents ?

MISE À JOUR

J'ai réussi à le faire apparaître en copiant les fichiers dans src/gonotes et de courir :

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

afin que les fichiers réels soient disponibles à l'adresse /Users/jonah/code/go/gonotes/src/gonotes .

Cela a pour effet secondaire de n'afficher aucune des librairies de tierce partie installées dans mon système par défaut. GOPATH J'aimerais donc trouver une solution qui me permette d'ajouter le répertoire courant, tel quel, sans ajouter src/curdir et qu'il apparaisse quand même.

Answer 1

En GOPATH mode

godoc -http servira les documents de tous les paquets disponibles, y compris la bibliothèque standard. Ne vous inquiétez pas, vos propres paquets sont parmi eux, il suffit de regarder à nouveau. En guise de raccourci, tapez simplement http://localhost:6060/pkg/your/package .

En mode de prise en compte des modules

GOPATH et les modules sont mutuellement exclusifs , voir Les modules Go ne reconnaissent pas les fichiers sous GOPATH . Les godoc n'est pas compatible avec les modules, et il est en voie d'obsolescence (voir avertissement de dépréciation ), donc pour l'instant si vous voulez voir les documents de votre paquet de modules localement dans godoc Il n'y a pas d'autre solution que de mettre ses sources dans une liste d'attente. src dossier.

"Solution de contournement pour voir la documentation des modules :

• Placez le repo dans un dossier comme /some/folder/src

• Démarrer godocs avec godoc -goroot=/some/folder -http=:6060

Voir le numéro correspondant : soutenir les modules Go

Discussion de groupe également : L'outil go 1.11 godoc est-il "module-aware" ?