Skip to content

Commit b337225

Browse files
ltalirzLeopold Talirz
andauthored
fix readthedocs build (#33)
Readthedocs build was broken because some json blocks in the docs container ellipses, making them invalid JSON. Furthermore, graphene changed some relevant API in version 3. Co-authored-by: Leopold Talirz <a-ctalirz@microsoft.com>
1 parent 9a38284 commit b337225

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ repos:
2424
- id: isort
2525

2626
- repo: https://github.com/psf/black
27-
rev: 21.5b2
27+
rev: 22.10.0
2828
hooks:
2929
- id: black
3030

@@ -51,7 +51,7 @@ repos:
5151
- fastapi~=0.65.1
5252
- uvicorn[standard]>=0.12.0,<0.14.0
5353
- pydantic~=1.8.2
54-
- graphene
54+
- graphene<3
5555
- lark
5656
- python-jose
5757
- python-multipart

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
else "{}-{}".format(copyright_first_year, current_year)
5353
)
5454
# pylint: disable=redefined-builtin
55-
copyright = u"{}, {}. All rights reserved".format(
55+
copyright = "{}, {}. All rights reserved".format(
5656
copyright_year_string, copyright_owners
5757
)
5858

docs/source/user_guide/tutorial.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For some of the REST API endpoints, you need an authentication token. Do the fol
1616

1717
To follow the steps in the tutorial below, you can use the Swagger Javascript client, which you can access at http://127.0.0.1:8000/docs
1818

19-
<!--
19+
<!--
2020
You will also need a tool to make HTTP requests. Here are two options:
2121
2222
**Option 1: HTTPie command line tool**
@@ -60,7 +60,7 @@ print( response.json )
6060
Here, we show how the REST API can be used to submit a WorkChain process to add two integers.
6161

6262
### Step 1: Post Code Object
63-
63+
6464
Request URL: http://127.0.0.1:8000/nodes
6565
Request Body:
6666
```json
@@ -144,7 +144,7 @@ After retrieving the UUIDs, the process is submitted at `/processes` endpoint as
144144
Request URL: http://127.0.0.1:8000/processes
145145

146146
Request Body:
147-
```json
147+
```json
148148
{
149149
"label": "report_process",
150150
"process_entry_point": "aiida.calculations:arithmetic.add",
@@ -160,7 +160,7 @@ After retrieving the UUIDs, the process is submitted at `/processes` endpoint as
160160
```
161161

162162
Response Body:
163-
```json
163+
```
164164
{
165165
"id": 64,
166166
"uuid": "6bc238e2-0dec-4449-bbe0-3cf181df00eb",
@@ -188,7 +188,7 @@ Once the process is submitted, its status can be checked:
188188
Request URL: http://127.0.0.1:8000/processes/64
189189

190190
Response Body:
191-
```json
191+
```
192192
{
193193
"id": 64,
194194
"uuid": "6bc238e2-0dec-4449-bbe0-3cf181df00eb",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
data:
2-
aiidaVersion: 1.6.5
2+
aiidaVersion: 1.6.9
33
node:
44
label: node 1

0 commit comments

Comments
 (0)