Skip to content

Commit 52349ef

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 12fd2b1 commit 52349ef

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

+3-48
Original file line numberDiff line numberDiff line change
@@ -75,52 +75,7 @@ Contributions are welcome! Please read our `Code of Conduct
7575
<https://github.com/adafruit/adafruit_CircuitPython_SSD1306/blob/master/CODE_OF_CONDUCT.md>`_
7676
before contributing to help this project stay welcoming.
7777

78-
Building locally
79-
================
80-
81-
Zip release files
82-
-----------------
83-
84-
To build this library locally you'll need to install the
85-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
86-
87-
.. code-block:: shell
88-
89-
python3 -m venv .env
90-
source .env/bin/activate
91-
pip install circuitpython-build-tools
92-
93-
Once installed, make sure you are in the virtual environment:
94-
95-
.. code-block:: shell
96-
97-
source .env/bin/activate
98-
99-
Then run the build:
100-
101-
.. code-block:: shell
102-
103-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ssd1306 --library_location .
104-
105-
Sphinx documentation
106-
-----------------------
107-
108-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
109-
install dependencies (feel free to reuse the virtual environment from above):
110-
111-
.. code-block:: shell
112-
113-
python3 -m venv .env
114-
source .env/bin/activate
115-
pip install Sphinx sphinx-rtd-theme
116-
117-
Now, once you have the virtual environment activated:
118-
119-
.. code-block:: shell
120-
121-
cd docs
122-
sphinx-build -E -W -b html . _build/html
78+
Documentation
79+
=============
12380

124-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
125-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
126-
locally verify it will pass.
81+
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

0 commit comments

Comments
 (0)