Skip to content

Commit

Permalink
Cleanup: documentation .rst files
Browse files Browse the repository at this point in the history
  • Loading branch information
ax3l committed Nov 8, 2021
1 parent 0995a48 commit 8ce396d
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 5 deletions.
1 change: 0 additions & 1 deletion docs/source/backends/json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,3 @@ when picking the JSON backend:

.. literalinclude:: json_example.json
:language: json

1 change: 0 additions & 1 deletion docs/source/citation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,3 @@ Python
.format(io.__version__))
print("openPMD-api backend variants: {}"
.format(io.variants))
1 change: 0 additions & 1 deletion docs/source/dev/sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,3 @@ Useful Links
* `A primer on writing restFUL files for sphinx <http://www.sphinx-doc.org/en/stable/rest.html>`_
* `Why You Shouldn't Use "Markdown" for Documentation <http://ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/>`_
* `Markdown Limitations in Sphinx <https://docs.readthedocs.io/en/latest/getting_started.html#in-markdown>`_

2 changes: 1 addition & 1 deletion docs/source/usage/streaming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ Note that a closed iteration cannot be reopened.
This pays tribute to the fact that in streaming mode, an iteration is sent to the sink upon closing it and the data source can no longer modify it.

.. literalinclude:: 10_streaming_write.py
:language: python3
:language: python3
2 changes: 1 addition & 1 deletion docs/source/utilities/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ With some ``pip``-based python installations, you might have to run this as a mo

.. code-block:: bash
python -m openpmd_api.pipe --help
python -m openpmd_api.pipe --help

0 comments on commit 8ce396d

Please sign in to comment.