Skip to content

Commit 62e9c1f

Browse files
README: Add formatting and amend doc build instructions (#494)
- add formatting to Git branch names - add formatting to Python module names - spell out Python version support
1 parent 36c8488 commit 62e9c1f

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The aim of the project is to support the most common parts of the CiA 301
66
standard in a simple Pythonic interface. It is mainly targeted for testing and
77
automation tasks rather than a standard compliant master implementation.
88

9-
The library supports Python 3.8+.
9+
The library supports Python 3.8 or newer.
1010

1111

1212
Features
@@ -36,11 +36,11 @@ Incomplete support for creating slave nodes also exists.
3636
Installation
3737
------------
3838

39-
Install from PyPI_ using pip::
39+
Install from PyPI_ using :program:`pip`::
4040

4141
$ pip install canopen
4242

43-
Install from latest master on GitHub::
43+
Install from latest ``master`` on GitHub::
4444

4545
$ pip install https://github.com/christiansandberg/canopen/archive/master.zip
4646

@@ -56,6 +56,10 @@ Unit tests can be run using the pytest_ framework::
5656
$ pip install pytest
5757
$ pytest -v
5858

59+
You can also use :mod:`unittest` standard library module::
60+
61+
$ python3 -m unittest discover test -v
62+
5963
Documentation
6064
-------------
6165

@@ -65,7 +69,8 @@ http://canopen.readthedocs.io/en/latest/
6569

6670
It can also be generated from a local clone using Sphinx_::
6771

68-
$ python setup.py build_sphinx
72+
$ pip install -r doc/requirements.txt
73+
$ make -C doc html
6974

7075

7176
Hardware support

0 commit comments

Comments
 (0)