Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Commit

Permalink
doc: update quick start guide with make doc steps (#1)
Browse files Browse the repository at this point in the history
Co-authored-by: Huang Hua <hua.huang@seagate.com>
  • Loading branch information
madhavemuri and Huang Hua authored Sep 24, 2020
1 parent 3df7308 commit f0e5ea9
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions doc/Quick-Start-Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,19 @@ Troubleshooting

**Note**: Make sure that the eth1 interface is present in the node by checking ifconfig. Else, update the new interface in the file.

**Build the documents **
Steps used to 'make' this doc:
install pip itself:
- curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
- python get-pip.py
- pip install -U sphinx (you may need to do "rpm -e --nodeps pyparsing.noarch")
- pip install sphinxcontrib.plantuml

- **Build the documents **
- Steps used to 'make' this doc:
- install pip itself:
- curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
- python get-pip.py
- pip install -U sphinx (you may need to do "rpm -e --nodeps pyparsing.noarch")
- pip install sphinxcontrib.plantuml
- install jre (java runtime environment) from Java.com
- install plantuml from plantuml.com
- create such an executable shell script:
$ cat /bin/plantuml
#!/bin/sh
/somewhere_to_your/bin/java -jar /somewhere_to_your/plantuml.jar $@
#!/bin/sh
/somewhere_to_your/bin/java -jar /somewhere_to_your/plantuml.jar $@


0 comments on commit f0e5ea9

Please sign in to comment.