Skip to content

Commit 7482140

Browse files
committed
Merge branch 'dev'
# Conflicts: # docs/source/jupyter/quantum-espresso.ipynb
2 parents bc7116d + 3735982 commit 7482140

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+4087
-1182
lines changed

.dockerignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.vscode/
2+
docs/build
3+
*.pyc
4+
build/
5+
dist/
6+
*.egg-info/
7+
.eggs/

.github/workflows/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# follows the same pattern as .gitignore files
2+
# file/mask username1/email1 ... usernameN/emailN
3+
4+
* @yoavnash @pablo-de-andres @kysrpex

README.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,50 @@
33
**dev** - [![Documentation dev](https://readthedocs.org/projects/simphony/badge/?version=dev)](https://simphony.readthedocs.io/en/latest/?badge=dev)
44

55
# 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).
77

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).
99

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.
2214

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+
```
2339

24-
If you want to render the documentation locally, you can run:
40+
Now you can start the server and render the docs:
2541
```
26-
python3 setup.py install
42+
$ sphinx-autobuild docs/source docs/build/html
2743
```
44+
The documentation will be available on [`http://127.0.0.1:8000`](http://127.0.0.1:8000).
2845

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
39.3 KB
Loading

docs/source/_static/img/mergedlinkeddata.svg

Lines changed: 3 additions & 0 deletions
Loading
7.17 KB
Loading

0 commit comments

Comments
 (0)