Skip to content

Commit 5e814c1

Browse files
authored
Merge pull request #248 from simphony/dev
Merge release 3.9.0
2 parents 7de48b7 + 6883e2f commit 5e814c1

39 files changed

+2629
-2281
lines changed

.dockerignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
.vscode/
2-
build/
2+
build/

.github/issue-branch.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,23 @@ on: pull_request
44

55
jobs:
66
build:
7-
87
runs-on: ubuntu-latest
98

109
steps:
11-
- uses: actions/checkout@v2
12-
- name: Set up Python 3.7
13-
uses: actions/setup-python@v2
14-
with:
15-
python-version: 3.7
16-
- name: Install OS dependencies
17-
run: |
18-
sudo apt-get update
19-
sudo apt-get install pandoc latexmk
20-
sudo apt-get install texlive-fonts-recommended texlive-latex-recommended texlive-latex-extra
21-
- name: Install python dependencies
22-
run: |
23-
python -m pip install --upgrade pip
24-
pip install wheel
25-
pip install -r requirements.txt
26-
- name: Build docs
27-
run: sphinx-build docs/source docs/build/html
10+
- uses: actions/checkout@v3
11+
- name: Set up Python 3.10
12+
uses: actions/setup-python@v3
13+
with:
14+
python-version: "3.10"
15+
- name: Install OS dependencies
16+
run: |
17+
sudo apt-get update
18+
sudo apt-get install pandoc latexmk
19+
sudo apt-get install texlive-fonts-recommended texlive-latex-recommended texlive-latex-extra
20+
- name: Install python dependencies
21+
run: |
22+
python -m pip install --upgrade pip
23+
pip install wheel
24+
pip install -r requirements.txt
25+
- name: Build docs
26+
run: sphinx-build docs/source docs/build/html

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
.vscode/
2-
build/
2+
build/

.pre-commit-config.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
ci:
3+
autoupdate_branch: "dev"
4+
5+
repos:
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: v4.2.0
8+
hooks:
9+
- id: check-json
10+
- id: pretty-format-json
11+
args: ["--autofix", "--no-sort-keys"]
12+
- id: check-yaml
13+
- id: end-of-file-fixer
14+
- id: trailing-whitespace
15+
16+
- repo: https://github.com/pre-commit/mirrors-prettier
17+
rev: v2.6.2
18+
hooks:
19+
- id: prettier
20+
files: \.(js|ts|jsx|tsx|css|less|html|markdown|md|yaml|yml)$
21+
22+
- repo: https://github.com/psf/black
23+
rev: 22.6.0
24+
hooks:
25+
- id: black
26+
args:
27+
- --line-length=79
28+
29+
- repo: https://github.com/pycqa/isort
30+
rev: 5.10.1
31+
hooks:
32+
- id: isort
33+
args:
34+
- --profile=black
35+
- --filter-files
36+
- --line-length=79

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,67 @@
11
## Build Status
2-
**latest** - [![Documentation latest](https://readthedocs.org/projects/simphony/badge/?version=latest)](https://simphony.readthedocs.io/en/latest/?badge=latest)
2+
3+
**latest** - [![Documentation latest](https://readthedocs.org/projects/simphony/badge/?version=latest)](https://simphony.readthedocs.io/en/latest/?badge=latest)
34
**dev** - [![Documentation dev](https://readthedocs.org/projects/simphony/badge/?version=dev)](https://simphony.readthedocs.io/en/latest/?badge=dev)
45

56
# SimPhoNy docs
7+
68
To access the documentation, please visit: [https://simphony.readthedocs.io](https://simphony.readthedocs.io).
79

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

1012
## Local Rendering
13+
1114
### HTML
15+
1216
A server will start, generate the docs and listen for changes in the source files.
1317
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.
1418

1519
#### Docker
20+
1621
First, build the Docker image by running the following command:
22+
1723
```shell
1824
$ docker build -f local_build.Dockerfile -t simphony-docs .
1925
```
2026

2127
Then, start the program by running:
28+
2229
```shell
2330
$ docker run --rm -v $PWD:/app -p 8000:8000 simphony-docs
2431
```
2532

2633
#### Linux
34+
2735
At an OS level (these commands work on Linux Debian):
36+
2837
```shell
2938
$ sudo apt install pandoc graphviz default-jre
3039
$ sudo apt-get install texlive-latex-recommended \
3140
texlive-latex-extra \
3241
texlive-fonts-recommended \
33-
latexmk
42+
latexmk
3443
```
44+
3545
The python dependencies:
46+
3647
```shell
3748
$ pip install -r requirements.txt
3849
```
3950

4051
Now you can start the server and render the docs:
52+
4153
```
4254
$ sphinx-autobuild docs/source docs/build/html
4355
```
44-
The documentation will be available on [`http://127.0.0.1:8000`](http://127.0.0.1:8000).
4556

57+
The documentation will be available on [`http://127.0.0.1:8000`](http://127.0.0.1:8000).
4658

4759
### PDF (LaTeX)
60+
4861
To generate a PDF of the documentation, simply run (from the root project folder):
62+
4963
```sh
5064
make -C docs latexpdf
5165
```
52-
The generated PDF can be found under docs/build/latex/SymPhoNy_docs.pdf
66+
67+
The generated PDF can be found under docs/build/latex/SymPhoNy_docs.pdf

docs/source/_static/custom.css

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.caption-text,
2+
h1,
3+
h2,
4+
h3,
5+
h4 {
6+
color: #6580a1 !important;
7+
}
8+
9+
.btn-outline-primary {
10+
border-color: #6580a1 !important;
11+
}
12+
13+
.btn-outline-primary:hover {
14+
background-color: #6580a1 !important;
15+
color: azure !important;
16+
}
17+
18+
@media (min-width: 1200px) {
19+
.container-xl {
20+
max-width: 1550px;
21+
}
22+
#site-navigation {
23+
max-width: 20%;
24+
}
25+
}

docs/source/_static/img/branch_workflow.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/source/_static/img/mergedlinkeddata.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)