Skip to content
This repository was archived by the owner on Oct 29, 2019. It is now read-only.

Commit 3506761

Browse files
committed
updated README
1 parent 18d2d68 commit 3506761

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.rst

Lines changed: 28 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_LSM303.svg?branch=master
14+
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_LSM303
15+
:alt: Build Status
16+
1317
Adafruit CircuitPython module for the LSM303 6-DoF with 3-axis accelerometer and magnetometer
1418

1519
Dependencies
@@ -49,14 +53,6 @@ Usage Example
4953
time.sleep(1.0)
5054
5155
52-
API Reference
53-
=============
54-
55-
.. toctree::
56-
:maxdepth: 2
57-
58-
api
59-
6056
Contributing
6157
============
6258

@@ -87,3 +83,27 @@ Then run the build:
8783
.. code-block:: shell
8884
8985
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lsm303 --library_location .
86+
87+
88+
Sphinx documentation
89+
-----------------------
90+
91+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
92+
install dependencies (feel free to reuse the virtual environment from above):
93+
94+
.. code-block:: shell
95+
96+
python3 -m venv .env
97+
source .env/bin/activate
98+
pip install Sphinx sphinx-rtd-theme
99+
100+
Now, once you have the virtual environment activated:
101+
102+
.. code-block:: shell
103+
104+
cd docs
105+
sphinx-build -E -W -b html . _build/html
106+
107+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
108+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
109+
locally verify it will pass.

0 commit comments

Comments
 (0)