Skip to content

Commit

Permalink
README: Add formatting and amend doc build instructions (#494)
Browse files Browse the repository at this point in the history
- add formatting to Git branch names
- add formatting to Python module names
- spell out Python version support
  • Loading branch information
erlend-aasland committed Jul 6, 2024
1 parent 36c8488 commit 62e9c1f
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The aim of the project is to support the most common parts of the CiA 301
standard in a simple Pythonic interface. It is mainly targeted for testing and
automation tasks rather than a standard compliant master implementation.

The library supports Python 3.8+.
The library supports Python 3.8 or newer.


Features
Expand Down Expand Up @@ -36,11 +36,11 @@ Incomplete support for creating slave nodes also exists.
Installation
------------

Install from PyPI_ using pip::
Install from PyPI_ using :program:`pip`::

$ pip install canopen

Install from latest master on GitHub::
Install from latest ``master`` on GitHub::

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

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

You can also use :mod:`unittest` standard library module::

$ python3 -m unittest discover test -v

Documentation
-------------

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

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

$ python setup.py build_sphinx
$ pip install -r doc/requirements.txt
$ make -C doc html


Hardware support
Expand Down

0 comments on commit 62e9c1f

Please sign in to comment.