Skip to content

Commit 5caebe1

Browse files
authored
Update README to work with pypi (#47)
1 parent bab0a63 commit 5caebe1

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,24 @@ A function in ``my_c_file.c``:
2828
return a + b;
2929
}
3030
31-
Could be referenced in documentation as::
31+
Could be referenced in documentation as:
32+
33+
.. code-block:: rst
3234
3335
.. autocfunction:: my_c_file.c::my_adding_function
3436
3537
With the resulting documentation output of:
3638

37-
.. c:function:: int my_adding_function(int a, int b)
3839

39-
A simple function that adds.
40+
.. code-block:: rst
41+
42+
.. c:function:: int my_adding_function(int a, int b)
43+
44+
A simple function that adds.
4045
41-
:param a: The initial value
42-
:param b: The value to add to `a`
43-
:returns: The sum of `a` and `b`
46+
:param a: The initial value
47+
:param b: The value to add to `a`
48+
:returns: The sum of `a` and `b`
4449
4550
.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
4651
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html

0 commit comments

Comments
 (0)