File tree 1 file changed +24
-13
lines changed
1 file changed +24
-13
lines changed Original file line number Diff line number Diff line change @@ -10,10 +10,6 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
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
-
17
13
CircuitPython module for the MCP4725 digital to analog converter.
18
14
19
15
Dependencies
@@ -29,15 +25,7 @@ This is easily achieved by downloading
29
25
Usage Example
30
26
=============
31
27
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.
41
29
42
30
Contributing
43
31
============
@@ -69,3 +57,26 @@ Then run the build:
69
57
.. code-block :: shell
70
58
71
59
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.
You can’t perform that action at this time.
0 commit comments