Skip to content

Commit 724b4c6

Browse files
committed
updated README
1 parent 7bc53f1 commit 724b4c6

File tree

1 file changed

+45
-6
lines changed

1 file changed

+45
-6
lines changed

README.rst

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This is easily achieved by downloading
2626
Usage Example
2727
=============
2828

29-
See examples/simpletest.py for a demo of the usage.
29+
See examples/max31865_simpletest.py for a demo of the usage.
3030

3131
Contributing
3232
============
@@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct
3535
<https://github.com/adafruit/Adafruit_CircuitPython_max31865/blob/master/CODE_OF_CONDUCT.md>`_
3636
before contributing to help this project stay welcoming.
3737

38-
API Reference
39-
=============
38+
Building locally
39+
================
40+
41+
To build this library locally you'll need to install the
42+
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
43+
44+
.. code-block:: shell
45+
46+
python3 -m venv .env
47+
source .env/bin/activate
48+
pip install circuitpython-build-tools
49+
50+
Once installed, make sure you are in the virtual environment:
51+
52+
.. code-block:: shell
53+
54+
source .env/bin/activate
55+
56+
Then run the build:
57+
58+
.. code-block:: shell
59+
60+
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31865 --library_location .
61+
62+
Sphinx documentation
63+
-----------------------
64+
65+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
66+
install dependencies (feel free to reuse the virtual environment from above):
67+
68+
.. code-block:: shell
69+
70+
python3 -m venv .env
71+
source .env/bin/activate
72+
pip install Sphinx sphinx-rtd-theme
73+
74+
Now, once you have the virtual environment activated:
75+
76+
.. code-block:: shell
4077
41-
.. toctree::
42-
:maxdepth: 2
78+
cd docs
79+
sphinx-build -E -W -b html . _build/html
4380
44-
api
81+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
82+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
83+
locally verify it will pass.

0 commit comments

Comments
 (0)