Skip to content

Commit d2b4ef0

Browse files
committed
updated README
1 parent e70e5cd commit d2b4ef0

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.rst

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Introduction
1010
:target: https://discord.gg/nBQh6qu
1111
:alt: Discord
1212
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+
1317
CircuitPython driver for common low-cost FocalTech capacitive touch chips.
1418
Currently supports FT6206 & FT6236
1519

@@ -44,14 +48,6 @@ Usage Example
4448
if n:
4549
print(ft.touches)
4650
47-
API Reference
48-
=============
49-
50-
.. toctree::
51-
:maxdepth: 2
52-
53-
api
54-
5551
Contributing
5652
============
5753

@@ -82,3 +78,26 @@ Then run the build:
8278
.. code-block:: shell
8379
8480
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.

0 commit comments

Comments
 (0)