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 @@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct
35
35
<https://github.com/adafruit/Adafruit_CircuitPython_fxos8700/blob/master/CODE_OF_CONDUCT.md> `_
36
36
before contributing to help this project stay welcoming.
37
37
38
- API Reference
39
- =============
38
+ Building locally
39
+ ================
40
+
41
+ To build this library locally you'll need to install the
42
+ `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
43
+
44
+ .. code-block :: shell
45
+
46
+ python3 -m venv .env
47
+ source .env/bin/activate
48
+ pip install circuitpython-build-tools
49
+
50
+ Once installed, make sure you are in the virtual environment:
51
+
52
+ .. code-block :: shell
53
+
54
+ source .env/bin/activate
55
+
56
+ Then run the build:
57
+
58
+ .. code-block :: shell
59
+
60
+ circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fxos8700 --library_location .
61
+
62
+ Sphinx documentation
63
+ -----------------------
64
+
65
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
66
+ install dependencies (feel free to reuse the virtual environment from above):
67
+
68
+ .. code-block :: shell
69
+
70
+ python3 -m venv .env
71
+ source .env/bin/activate
72
+ pip install Sphinx sphinx-rtd-theme
73
+
74
+ Now, once you have the virtual environment activated:
75
+
76
+ .. code-block :: shell
40
77
41
- .. toctree ::
42
- :maxdepth: 2
78
+ cd docs
79
+ sphinx-build -E -W -b html . _build/html
43
80
44
- api
81
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
82
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
83
+ locally verify it will pass
You can’t perform that action at this time.
0 commit comments