Skip to content

Commit 39af848

Browse files
authored
Merge pull request #2 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents f5fa2c5 + 8108425 commit 39af848

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

README.rst

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

78-
Sphinx documentation
79-
-----------------------
80-
81-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
82-
install dependencies (feel free to reuse the virtual environment from above):
83-
84-
.. code-block:: shell
85-
86-
python3 -m venv .env
87-
source .env/bin/activate
88-
pip install Sphinx sphinx-rtd-theme
89-
90-
Now, once you have the virtual environment activated:
91-
92-
.. code-block:: shell
93-
94-
cd docs
95-
sphinx-build -E -W -b html . _build/html
78+
Documentation
79+
=============
9680

97-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
98-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
99-
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)