Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/source/jupyter/quantum-espresso.ipynb
  • Loading branch information
kysrpex committed Apr 12, 2021
2 parents bc7116d + 3735982 commit 7482140
Show file tree
Hide file tree
Showing 41 changed files with 4,087 additions and 1,182 deletions.
7 changes: 7 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.vscode/
docs/build
*.pyc
build/
dist/
*.egg-info/
.eggs/
4 changes: 4 additions & 0 deletions .github/workflows/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# follows the same pattern as .gitignore files
# file/mask username1/email1 ... usernameN/emailN

* @yoavnash @pablo-de-andres @kysrpex
57 changes: 40 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,50 @@
**dev** - [![Documentation dev](https://readthedocs.org/projects/simphony/badge/?version=dev)](https://simphony.readthedocs.io/en/latest/?badge=dev)

# SimPhoNy docs
To access the documentation, please visit: https://simphony.readthedocs.io/en/latest/
To access the documentation, please visit: [https://simphony.readthedocs.io](https://simphony.readthedocs.io).

If you find any error or problem with the documentation, please [create an issue](https://github.com/simphony/docs/issues)
If you find any error or problem with the documentation, please [create an issue](https://github.com/simphony/docs/issues).

## Local installation
First, some requirements have to be manually installed:
- [osp-core](https://github.com/simphony/osp-core)
- pandoc
- LaTeX requirements
```shell
sudo apt install pandoc
sudo apt-get install texlive-latex-recommended \
texlive-latex-extra \
texlive-fonts-recommended \
latexmk
```
## Local Rendering
### HTML
A server will start, generate the docs and listen for changes in the source files.
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.

#### Docker
First, build the Docker image by running the following command:
```shell
$ docker build -f local_build.Dockerfile -t simphony-docs .
```

Then, start the program by running:
```shell
$ docker run --rm -v $PWD:/app -p 8000:8000 simphony-docs
```

#### Linux
At an OS level (these commands work on Linux Debian):
```shell
$ sudo apt install pandoc graphviz default-jre
$ sudo apt-get install texlive-latex-recommended \
texlive-latex-extra \
texlive-fonts-recommended \
latexmk
```
The python dependencies:
```shell
$ pip install -r requirements.txt
```

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

This will render the html and generate a LaTeX pdf (in `docs/build/latex/SimPhoNy_docs.pdf`).

### PDF (LaTeX)
To generate a PDF of the documentation, simply run (from the root project folder):
```sh
make -C docs latexpdf
```
The generated PDF can be found under docs/build/latex/SymPhoNy_docs.pdf
Binary file added docs/source/_static/img/branch_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/img/mergedlinkeddata.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/overview_slider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7482140

Please sign in to comment.