File tree Expand file tree Collapse file tree 1 file changed +44
-5
lines changed Expand file tree Collapse file tree 1 file changed +44
-5
lines changed Original file line number Diff line number Diff line change @@ -76,10 +76,49 @@ Contributions are welcome! Please read our `Code of Conduct
7676<https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/master/CODE_OF_CONDUCT.md> `_
7777before contributing to help this project stay welcoming.
7878
79- API Reference
80- =============
79+ Building locally
80+ ================
81+
82+ To build this library locally you'll need to install the
83+ `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
84+
85+ .. code-block :: shell
86+
87+ python3 -m venv .env
88+ source .env/bin/activate
89+ pip install circuitpython-build-tools
90+
91+ Once installed, make sure you are in the virtual environment:
92+
93+ .. code-block :: shell
94+
95+ source .env/bin/activate
96+
97+ Then run the build:
98+
99+ .. code-block :: shell
100+
101+ circuitpython-build-bundles --filename_prefix adafruit-circuitpython-neopixel --library_location .
102+
103+ Sphinx documentation
104+ -----------------------
105+
106+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
107+ install dependencies (feel free to reuse the virtual environment from above):
108+
109+ .. code-block :: shell
110+
111+ python3 -m venv .env
112+ source .env/bin/activate
113+ pip install Sphinx sphinx-rtd-theme
114+
115+ Now, once you have the virtual environment activated:
116+
117+ .. code-block :: shell
81118
82- .. toctree ::
83- :maxdepth: 2
119+ cd docs
120+ sphinx-build -E -W -b html . _build/html
84121
85- api
122+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
123+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
124+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments