File tree Expand file tree Collapse file tree 1 file changed +0
-49
lines changed Expand file tree Collapse file tree 1 file changed +0
-49
lines changed Original file line number Diff line number Diff line change @@ -39,52 +39,3 @@ Contributions are welcome! Please read our `Code of Conduct
3939<https://github.com/adafruit/Adafruit_CircuitPython_PyPortal/blob/master/CODE_OF_CONDUCT.md> `_
4040before contributing to help this project stay welcoming.
4141
42- Building locally
43- ================
44-
45- Zip release files
46- -----------------
47-
48- To build this library locally you'll need to install the
49- `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
50-
51- .. code-block :: shell
52-
53- python3 -m venv .env
54- source .env/bin/activate
55- pip install circuitpython-build-tools
56-
57- Once installed, make sure you are in the virtual environment:
58-
59- .. code-block :: shell
60-
61- source .env/bin/activate
62-
63- Then run the build:
64-
65- .. code-block :: shell
66-
67- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pyportal --library_location .
68-
69- Sphinx documentation
70- -----------------------
71-
72- Sphinx is used to build the documentation based on rST files and comments in the code. First,
73- install dependencies (feel free to reuse the virtual environment from above):
74-
75- .. code-block :: shell
76-
77- python3 -m venv .env
78- source .env/bin/activate
79- pip install Sphinx sphinx-rtd-theme
80-
81- Now, once you have the virtual environment activated:
82-
83- .. code-block :: shell
84-
85- cd docs
86- sphinx-build -E -W -b html . _build/html
87-
88- This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
89- view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
90- locally verify it will pass.
You can’t perform that action at this time.
0 commit comments