Skip to content

Commit e240541

Browse files
committed
updated README
1 parent 139a29a commit e240541

File tree

1 file changed

+51
-5
lines changed

1 file changed

+51
-5
lines changed

README.rst

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,56 @@ To read the gas sensor and temperature simply read the attributes:
6060
6161
print("CO2: ", ccs.eCO2, " TVOC:", ccs.TVOC, " temp:", ccs.temperature)
6262
63-
API Reference
64-
=============
63+
Contributing
64+
============
65+
66+
Contributions are welcome! Please read our `Code of Conduct
67+
<https://github.com/adafruit/Adafruit_CircuitPython_VEML6070/blob/master/CODE_OF_CONDUCT.md>`_
68+
before contributing to help this project stay welcoming.
69+
70+
Building locally
71+
================
72+
73+
To build this library locally you'll need to install the
74+
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
75+
76+
.. code-block:: shell
77+
78+
python3 -m venv .env
79+
source .env/bin/activate
80+
pip install circuitpython-build-tools
81+
82+
Once installed, make sure you are in the virtual environment:
83+
84+
.. code-block:: shell
85+
86+
source .env/bin/activate
87+
88+
Then run the build:
89+
90+
.. code-block:: shell
91+
92+
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ccs811 --library_location .
93+
94+
Sphinx documentation
95+
-----------------------
96+
97+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
98+
install dependencies (feel free to reuse the virtual environment from above):
99+
100+
.. code-block:: shell
101+
102+
python3 -m venv .env
103+
source .env/bin/activate
104+
pip install Sphinx sphinx-rtd-theme
105+
106+
Now, once you have the virtual environment activated:
107+
108+
.. code-block:: shell
65109
66-
.. toctree::
67-
:maxdepth: 2
110+
cd docs
111+
sphinx-build -E -W -b html . _build/html
68112
69-
api
113+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
114+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
115+
locally verify it will pass.

0 commit comments

Comments
 (0)