Skip to content

Commit ff551bd

Browse files
committed
updated README
1 parent d813ae4 commit ff551bd

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

README.rst

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ Introduction
1010
:target: https://discord.gg/nBQh6qu
1111
:alt: Discord
1212
13-
.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MCP4725.svg?branch=master
14-
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MCP4725
15-
:alt: Build Status
16-
1713
CircuitPython module for the MCP4725 digital to analog converter.
1814

1915
Dependencies
@@ -29,15 +25,7 @@ This is easily achieved by downloading
2925
Usage Example
3026
=============
3127

32-
See examples/simpletest.py for a demo of the usage.
33-
34-
API Reference
35-
=============
36-
37-
.. toctree::
38-
:maxdepth: 2
39-
40-
api
28+
See examples/max4725_simpletest.py for a demo of the usage.
4129

4230
Contributing
4331
============
@@ -69,3 +57,26 @@ Then run the build:
6957
.. code-block:: shell
7058
7159
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mcp4725 --library_location .
60+
61+
Sphinx documentation
62+
-----------------------
63+
64+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
65+
install dependencies (feel free to reuse the virtual environment from above):
66+
67+
.. code-block:: shell
68+
69+
python3 -m venv .env
70+
source .env/bin/activate
71+
pip install Sphinx sphinx-rtd-theme
72+
73+
Now, once you have the virtual environment activated:
74+
75+
.. code-block:: shell
76+
77+
cd docs
78+
sphinx-build -E -W -b html . _build/html
79+
80+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
81+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
82+
locally verify it will pass.

0 commit comments

Comments
 (0)