|
3 | 3 | **dev** - [](https://simphony.readthedocs.io/en/latest/?badge=dev) |
4 | 4 |
|
5 | 5 | # SimPhoNy docs |
6 | | -To access the documentation, please visit: https://simphony.readthedocs.io/en/latest/ |
| 6 | +To access the documentation, please visit: [https://simphony.readthedocs.io](https://simphony.readthedocs.io). |
7 | 7 |
|
8 | | -If you find any error or problem with the documentation, please [create an issue](https://github.com/simphony/docs/issues) |
| 8 | +If you find any error or problem with the documentation, please [create an issue](https://github.com/simphony/docs/issues). |
9 | 9 |
|
10 | | -## Local installation |
11 | | -First, some requirements have to be manually installed: |
12 | | -- [osp-core](https://github.com/simphony/osp-core) |
13 | | -- pandoc |
14 | | -- LaTeX requirements |
15 | | - ```shell |
16 | | - sudo apt install pandoc |
17 | | - sudo apt-get install texlive-latex-recommended \ |
18 | | - texlive-latex-extra \ |
19 | | - texlive-fonts-recommended \ |
20 | | - latexmk |
21 | | - ``` |
| 10 | +## Local Rendering |
| 11 | +### HTML |
| 12 | +A server will start, generate the docs and listen for changes in the source files. |
| 13 | +This can be done by using docker or installing the development environment directly on the you machine. Next are installation guides for Docker and Linux OS. |
22 | 14 |
|
| 15 | +#### Docker |
| 16 | +First, build the Docker image by running the following command: |
| 17 | +```shell |
| 18 | +$ docker build -f local_build.Dockerfile -t simphony-docs . |
| 19 | +``` |
| 20 | + |
| 21 | +Then, start the program by running: |
| 22 | +```shell |
| 23 | +$ docker run --rm -v $PWD:/app -p 8000:8000 simphony-docs |
| 24 | +``` |
| 25 | + |
| 26 | +#### Linux |
| 27 | +At an OS level (these commands work on Linux Debian): |
| 28 | +```shell |
| 29 | +$ sudo apt install pandoc graphviz default-jre |
| 30 | +$ sudo apt-get install texlive-latex-recommended \ |
| 31 | + texlive-latex-extra \ |
| 32 | + texlive-fonts-recommended \ |
| 33 | + latexmk |
| 34 | +``` |
| 35 | +The python dependencies: |
| 36 | +```shell |
| 37 | +$ pip install -r requirements.txt |
| 38 | +``` |
23 | 39 |
|
24 | | -If you want to render the documentation locally, you can run: |
| 40 | +Now you can start the server and render the docs: |
25 | 41 | ``` |
26 | | -python3 setup.py install |
| 42 | +$ sphinx-autobuild docs/source docs/build/html |
27 | 43 | ``` |
| 44 | +The documentation will be available on [`http://127.0.0.1:8000`](http://127.0.0.1:8000). |
28 | 45 |
|
29 | | -This will render the html and generate a LaTeX pdf (in `docs/build/latex/SimPhoNy_docs.pdf`). |
| 46 | + |
| 47 | +### PDF (LaTeX) |
| 48 | +To generate a PDF of the documentation, simply run (from the root project folder): |
| 49 | +```sh |
| 50 | +make -C docs latexpdf |
| 51 | +``` |
| 52 | +The generated PDF can be found under docs/build/latex/SymPhoNy_docs.pdf |
0 commit comments