File tree 1 file changed +27
-8
lines changed
1 file changed +27
-8
lines changed Original file line number Diff line number Diff line change @@ -10,6 +10,10 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_FocalTouch.svg?branch=master
14
+ :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_FocalTouch
15
+ :alt: Build Status
16
+
13
17
CircuitPython driver for common low-cost FocalTech capacitive touch chips.
14
18
Currently supports FT6206 & FT6236
15
19
@@ -44,14 +48,6 @@ Usage Example
44
48
if n:
45
49
print (ft.touches)
46
50
47
- API Reference
48
- =============
49
-
50
- .. toctree ::
51
- :maxdepth: 2
52
-
53
- api
54
-
55
51
Contributing
56
52
============
57
53
@@ -82,3 +78,26 @@ Then run the build:
82
78
.. code-block :: shell
83
79
84
80
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-focaltouch --library_location .
81
+
82
+ Sphinx documentation
83
+ -----------------------
84
+
85
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
86
+ install dependencies (feel free to reuse the virtual environment from above):
87
+
88
+ .. code-block :: shell
89
+
90
+ python3 -m venv .env
91
+ source .env/bin/activate
92
+ pip install Sphinx sphinx-rtd-theme
93
+
94
+ Now, once you have the virtual environment activated:
95
+
96
+ .. code-block :: shell
97
+
98
+ cd docs
99
+ sphinx-build -E -W -b html . _build/html
100
+
101
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
102
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
103
+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments