Skip to content

Commit

Permalink
fix readthedocs build (#33)
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
ltalirz and Leopold Talirz authored Nov 1, 2022
1 parent 9a38284 commit b337225
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ repos:
- id: isort

- repo: https://github.com/psf/black
rev: 21.5b2
rev: 22.10.0
hooks:
- id: black

Expand All @@ -51,7 +51,7 @@ repos:
- fastapi~=0.65.1
- uvicorn[standard]>=0.12.0,<0.14.0
- pydantic~=1.8.2
- graphene
- graphene<3
- lark
- python-jose
- python-multipart
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
else "{}-{}".format(copyright_first_year, current_year)
)
# pylint: disable=redefined-builtin
copyright = u"{}, {}. All rights reserved".format(
copyright = "{}, {}. All rights reserved".format(
copyright_year_string, copyright_owners
)

Expand Down
10 changes: 5 additions & 5 deletions docs/source/user_guide/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For some of the REST API endpoints, you need an authentication token. Do the fol

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

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

### Step 1: Post Code Object

Request URL: http://127.0.0.1:8000/nodes
Request Body:
```json
Expand Down Expand Up @@ -144,7 +144,7 @@ After retrieving the UUIDs, the process is submitted at `/processes` endpoint as
Request URL: http://127.0.0.1:8000/processes

Request Body:
```json
```json
{
"label": "report_process",
"process_entry_point": "aiida.calculations:arithmetic.add",
Expand All @@ -160,7 +160,7 @@ After retrieving the UUIDs, the process is submitted at `/processes` endpoint as
```

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

Response Body:
```json
```
{
"id": 64,
"uuid": "6bc238e2-0dec-4449-bbe0-3cf181df00eb",
Expand Down
2 changes: 1 addition & 1 deletion tests/test_graphql/test_full/test_full.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data:
aiidaVersion: 1.6.5
aiidaVersion: 1.6.9
node:
label: node 1

0 comments on commit b337225

Please sign in to comment.