从Git中心存储库查看文档

时间:2018-08-09 13:35:41

标签: makefile python-sphinx

我已经克隆了存储库-https://github.com/hyperledger/sawtooth-supply-chain。此存储库中有一个docs文件夹,其中有一个名为“源”的文件夹以及名为“ Makefile”和“ supply-chain-build-docs”的文件

我想知道是否在此目录中构建内容,是否可以查看ReadMe.md文件中的内容以外的其他文档。

如果是,我应该如何构建和查看文件?我已经安装了狮身人面像。

构建后我可以在哪个端口查看html文档?

1 个答案:

答案 0 :(得分:1)

如果打开supply-chain-build-docs文件,您会注意到其中提到了构建文档的说明。

说明:   构建构建锯齿供应链文档所需的环境   运行图像会将文档放入   sawtooth-supply-chain / docs /在本地计算机上构建。

内部版本:

  $ cd sawtooth-supply-chain
  $ docker build . -f docs/supply-chain-build-docs -t supply-chain-build-docs

运行:

  $ cd sawtooth-supply-chain
  $ docker run -v $(pwd):/project/sawtooth-supply-chain supply-chain-build-docs

此文档尽管假定您已经安装了docker。可在here

中找到在ubuntu中安装它的指南。
  

构建后我可以在哪个端口查看html文档?

完成上述两个步骤后,就可以在名为sawtooth-supply-chain/docs/build/latex的位置sawtooth.pdf上找到整洁的pdf文件:)