Skip to content

Commit a7ae977

Browse files
committed
updated README
1 parent ce99288 commit a7ae977

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_AVRprog.svg?branch=master
14+
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_AVRprog
15+
:alt: Build Status
16+
1317
Program your favorite AVR chips directly from CircuitPython with this handy helper class that will let you make stand-alone programmers right from your REPL. Should work with any/all AVR chips, via SPI programming. Tested with ATmega328, ATtiny85 and ATmega2560
1418

1519
Dependencies
@@ -27,14 +31,6 @@ Usage Example
2731

2832
See examples folder for full examples that progam various bootloaders onto chips.
2933

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

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

0 commit comments

Comments
 (0)