Skip to content

Commit 076d48e

Browse files
committed
updated README
1 parent 8c43910 commit 076d48e

File tree

1 file changed

+44
-9
lines changed

1 file changed

+44
-9
lines changed

README.rst

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ Introduction
66
:target: https://circuitpython.readthedocs.io/projects/sdcard/en/latest/
77
:alt: Documentation Status
88

9-
.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
10-
:target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
11-
:alt: Gitter
12-
139
.. image :: https://img.shields.io/discord/327254708534116352.svg
1410
:target: https://adafru.it/discord
1511
:alt: Discord
@@ -64,10 +60,49 @@ Contributions are welcome! Please read our `Code of Conduct
6460
<https://github.com/adafruit/Adafruit_CircuitPython_sdcard/blob/master/CODE_OF_CONDUCT.md>`_
6561
before contributing to help this project stay welcoming.
6662

67-
API Reference
68-
=============
63+
Building locally
64+
================
65+
66+
To build this library locally you'll need to install the
67+
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
68+
69+
.. code-block:: shell
70+
71+
python3 -m venv .env
72+
source .env/bin/activate
73+
pip install circuitpython-build-tools
74+
75+
Once installed, make sure you are in the virtual environment:
76+
77+
.. code-block:: shell
78+
79+
source .env/bin/activate
80+
81+
Then run the build:
82+
83+
.. code-block:: shell
84+
85+
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sd --library_location .
86+
87+
Sphinx documentation
88+
-----------------------
89+
90+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
91+
install dependencies (feel free to reuse the virtual environment from above):
92+
93+
.. code-block:: shell
94+
95+
python3 -m venv .env
96+
source .env/bin/activate
97+
pip install Sphinx sphinx-rtd-theme
98+
99+
Now, once you have the virtual environment activated:
100+
101+
.. code-block:: shell
69102
70-
.. toctree::
71-
:maxdepth: 2
103+
cd docs
104+
sphinx-build -E -W -b html . _build/html
72105
73-
api
106+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
107+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
108+
locally verify it will pass.

0 commit comments

Comments
 (0)