Commit 65e71040 authored by Robert Imschweiler's avatar Robert Imschweiler
Browse files

docs: Fix build deps and Python Bindings page.

[CONTRIBUTING.md]
- In order to be able to build the documentation, the package
`sphinxcontrib-katex` also needs to be installed via pip.

[docs/guides/python_bindings.md]
- According to the matplotlib documentation [1], the second argument
to `imshow` needs to be a string describing a colormap name or an
instance of a ColorMap. An error occurred with the previously used
argument as it did not describe a defined colormap. As the argument is
optional, it can just be omitted (or replaced according to personal
style preferences).
- The relative link to the Quickstart page did not work, it has been
replaced by a doc-link according to the sphinx documentation [2].

[1] matplotlib.org/3.5.0/api/_as_gen/matplotlib.pyplot.imshow.html
[2] docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html#the-doc-role
parent f6b6baec
Pipeline #866968 passed with stages
in 46 minutes and 16 seconds
...@@ -129,7 +129,7 @@ something is wrong. ...@@ -129,7 +129,7 @@ something is wrong.
The [elsa documentation](https://ciip.in.tum.de/elsadocs/) is automatically built and deployed through the CI for each commit to master. The [elsa documentation](https://ciip.in.tum.de/elsadocs/) is automatically built and deployed through the CI for each commit to master.
To build it locally the following packages are required: `sphinx doxygen` which should be available in To build it locally the following packages are required: `sphinx doxygen` which should be available in
most major linux distributions or via pip. Additionally, the following sphinx extensions need to be installed via pip: most major linux distributions or via pip. Additionally, the following sphinx extensions need to be installed via pip:
`sphinx-rtd-theme m2r2 breathe`. `sphinx-rtd-theme sphinxcontrib-katex m2r2 breathe`.
Then simply build the documentation using ninja Then simply build the documentation using ninja
``` ```
mkdir -p build mkdir -p build
......
...@@ -21,8 +21,8 @@ import pyelsa as elsa ...@@ -21,8 +21,8 @@ import pyelsa as elsa
``` ```
### 2D example ### 2D example
To give a short outline into the python usage of elsa we will recreate the 2D example of the [Quickstart](Quickstart) section To give a short outline into the python usage of elsa we will recreate the 2D example of the
in python. :doc:`./quickstart-cxx` section in python.
```python ```python
import pyelsa as elsa import pyelsa as elsa
...@@ -55,7 +55,7 @@ n_iterations = 20 ...@@ -55,7 +55,7 @@ n_iterations = 20
reconstruction = solver.solve(n_iterations) reconstruction = solver.solve(n_iterations)
# plot the reconstruction # plot the reconstruction
plt.imshow(np.array(reconstruction), '2D Reconstruction') plt.imshow(np.array(reconstruction))
plt.show() plt.show()
``` ```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment