在浏览器中本地查看软件包文档

时间:2019-05-27 21:11:25

标签: go

我想在本地查看我的软件包文档的外观。也就是说,我想看到的是与您在godoc.org上看到的一样的东西,但仅限于本地。

我在本地有一个简单的示例文件夹,但无法使用。正确输出文本文档:

<form id='main'>
  <header class='menu'>
    <label for="date0">Date of Requests</label>
    <input id="date0" name='date' class="date" type="date">
    <label for="TOR">Tasks</label>
    <select id="TOR" class="menu">
      <option value='-1' selected>Choose a Task</option>
      <option value="0">Task 1</option>
      <option value="1">Task 2</option>
      <option value="2">Task 3</option>
      <option value="3">Task 4</option>
      <option value="4">Task 5</option>
    </select>
  </header>
  <section class='task'>
    <fieldset id='CO' name='tasks' class="task show">
      <legend>Task 1</legend>
      <p>CO</p>
      <p>CO</p>
      <p>CO</p>
      <p>CO</p>
    </fieldset>
    <fieldset id='ASM' name='tasks' class="task">
      <legend>Task 2</legend>
      <p>ASM</p>
      <p>ASM</p>
      <p>ASM</p>
      <p>ASM</p>
      <p>ASM</p>
      <p>ASM</p>
    </fieldset>
    <fieldset id='SM' name='tasks' class="task">
      <legend>Task 3</legend>
      <p>SM</p>
      <p>SM</p>
      <p>SM</p>
      <p>SM</p>
      <p>SM</p>
      <p>SM</p>
      <p>SM</p>
      <p>SM</p>
    </fieldset>
    <fieldset id='AM' name='tasks' class="task">
      <legend>Task 4</legend>
      <p>AM</p>
      <p>AM</p>
      <p>AM</p>
      <p>AM</p>
    </fieldset>
    <fieldset id='RC' name='tasks' class="task">
      <legend>Task 5</legend>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
      <p>RC</p>
    </fieldset>
  </section>
</form>

但是,如果我运行~/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,我看到的内容基本上与golang.com主页上的内容相同。 http://localhost:6060/显示

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,并且仍然显示它。

1 个答案:

答案 0 :(得分:1)

I am tsnowlan I am in /packages total 0 drwxrwxr-x 3 root root 39 May 28 12:23 . drwxr-xr-x 1 tsnowlan tsnowlan 60 May 28 12:24 .. drwxrwxr-x 6 root root 117 May 28 12:23 rootpy-tutorials vim is: /usr/local/bin/vim 模式下

GOPATH将提供所有可用软件包的文档,包括标准库。不用担心,您自己的软件包就在其中,请再次查看。作为快捷方式,只需键入godoc -http

在模块感知模式下

http://localhost:6060/pkg/your/package和模块是互斥,请参见Go Modules does not recognize files under GOPATHGOPATH工具不支持模块,并且已弃用(请参见deprecation warning),因此,现在,如果您想在godoc中本地查看模块的软件包文档,可以使用求助于将其来源放入godoc文件夹中。

“解决方法”,用于查看模块的文档:

  • 将存储库放入src

  • 之类的文件夹中
  • 使用/some/folder/src

  • 启动godocs

查看相关问题:support Go modules

也分组讨论:Is the go 1.11 godoc tool 'module-aware'?