| commit | 775b63a5ff3f5c0582d4ab61226bec490073b9bb | [log] [tgz] |
|---|---|---|
| author | Junxiao Shi <git@mail1.yoursunny.com> | Sun Mar 03 19:55:30 2019 +0000 |
| committer | Junxiao Shi <git@mail1.yoursunny.com> | Sun Mar 03 19:55:30 2019 +0000 |
| tree | 2155b7affa75d1362969f2263579352a8f7055c1 | |
| parent | f27e321ad62c7fa16f60e02fdcb75776b30b6b19 [diff] |
README: fix Sphinx setup commands for Ubuntu refs #4854 Change-Id: Id36804d19d7d2011fcde23ab3eb3c9a9fd00bee0
To "compile" documentation into html form you would need to install Sphinx documentation package, which should be relatively trivial.
If you're on macOS:
If you're on Ubuntu Linux 16.04:
sudo apt install python3-pip sudo pip3 install -U pip setuptools sudo pip3 install -U sphinx sphinxcontrib-bibtex sphinxcontrib-fulltoc
Just type
make html
And a set of HTML pages will be build under _build/html
You can also type
make latexpdf
This way Sphinx will prepare .tex file and will try to build .pdf document.