Skip to content

Commit 51db9ba

Browse files
author
Marco Paolini
committed
Fix reStructuredText syntax
1 parent 03c2754 commit 51db9ba

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

README.rst

+14-14
Original file line numberDiff line numberDiff line change
@@ -13,39 +13,39 @@ Installing
1313

1414
Prerequisites:
1515

16-
- Install `cython`
17-
- Download and build `libgraphqlparser`
16+
- Install ``cython``
17+
- Download and build ``libgraphqlparser``
1818

1919

2020
Install using pip
2121

22-
- set an env var `$GRAPHQL_HOME` to libgraphqlparser dir
23-
- `LDFLAGS="-L$GRAPHQL_HOME" CFLAGS="-I$GRAPHQL_HOME/c -I$GRAPHQL_HOME" pip install graphqlparser`
22+
- set an env var ``$GRAPHQL_HOME`` to the folder where libgraphqlparser is
23+
- ``LDFLAGS="-L$GRAPHQL_HOME" CFLAGS="-I$GRAPHQL_HOME/c -I$GRAPHQL_HOME" pip install graphqlparser``
2424

2525

2626
Building from source
2727
--------------------
2828

2929
Needed to rebuild the generate cython files from the libgraphql AST
3030

31-
- download submodules with `git checkout --recursive`
32-
- build libgraphql library in folder `./libgraphql` (python2.7 required for building)
33-
(usually `pushd libgraphqlparser && cmake . && make && popd` works)
34-
- generate source code with `python ast/build_ast.py`
31+
- download submodules with ``git checkout --recursive``
32+
- build libgraphql library in folder ``./libgraphqlparser`` (python2.7 required for building)
33+
(usually ``pushd libgraphqlparser && cmake . && make && popd`` works)
34+
- generate source code with ``python ast/build_ast.py``
3535
- you can now switch to python 3
36-
- install `cython`
37-
- run `LDFLAGS="-L./libgraphqlparser" CFLAGS="-Ilibgraphqlparser/c -Ilibgraphqlparser" python setup.py build_ext`
36+
- install ``cython``
37+
- run ``LDFLAGS="-L./libgraphqlparser" CFLAGS="-Ilibgraphqlparser/c -Ilibgraphqlparser" python setup.py build_ext``
3838

3939
To package with wheel:
40-
- install wheel
41-
- create wheelhouse `mkdir .wheelhouse`
42-
- build with `pip wheel --wheel-dir=.wheelhouse .`
40+
- install wheel: ``pip install wheel``
41+
- create wheelhouse ``mkdir .wheelhouse``
42+
- build with ``pip wheel --wheel-dir=.wheelhouse .``
4343

4444

4545
Run
4646
---
4747

48-
Make sure `libgraphql` is available to the loader in your `LD_LIBRARY_PATH`
48+
Make sure ``libgraphqlparser`` is available to the loader. You can add its base dir to ``LD_LIBRARY_PATH``.
4949

5050

5151
Known issues

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
author_email='markopaolini@gmail.com',
2121
description='Python bindings for libgraphqlparser (Cython-based)',
2222
long_description='\n\n'.join([open('README.rst', 'r').read(),
23-
'-----', '-----',
23+
'-----',
2424
open('NEWS.rst', 'r').read()]),
2525
url='https://github.com/elastic-coders/py-graphqlparser',
2626
packages=['graphql_parser'],

0 commit comments

Comments
 (0)