Skip to content

Commit 35e0287

Browse files
committed
updated README
1 parent 72e3c92 commit 35e0287

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_FeatherWing.svg?branch=master
14+
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_FeatherWing
15+
:alt: Build Status
16+
1317
This library provides FeatherWing specific classes for those that require a significant amount of
1418
initialization.
1519

@@ -26,14 +30,6 @@ This is easily achieved by downloading
2630
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ and highly recommended over
2731
installing each one.
2832

29-
API Reference
30-
=============
31-
32-
.. toctree::
33-
:maxdepth: 2
34-
35-
api
36-
3733
Contributing
3834
============
3935

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

0 commit comments

Comments
 (0)