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