updated README
This commit is contained in:
		
							
								
								
									
										51
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										51
									
								
								README.rst
									
									
									
									
									
								
							@@ -26,7 +26,7 @@ This is easily achieved by downloading
 | 
			
		||||
Usage Example
 | 
			
		||||
=============
 | 
			
		||||
 | 
			
		||||
See examples/simpletest.py for a demo of the usage.
 | 
			
		||||
See examples/max31865_simpletest.py for a demo of the usage.
 | 
			
		||||
 | 
			
		||||
Contributing
 | 
			
		||||
============
 | 
			
		||||
@@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct
 | 
			
		||||
<https://github.com/adafruit/Adafruit_CircuitPython_max31865/blob/master/CODE_OF_CONDUCT.md>`_
 | 
			
		||||
before contributing to help this project stay welcoming.
 | 
			
		||||
 | 
			
		||||
API Reference
 | 
			
		||||
=============
 | 
			
		||||
Building locally
 | 
			
		||||
================
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
   :maxdepth: 2
 | 
			
		||||
To build this library locally you'll need to install the
 | 
			
		||||
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
 | 
			
		||||
 | 
			
		||||
   api
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    python3 -m venv .env
 | 
			
		||||
    source .env/bin/activate
 | 
			
		||||
    pip install circuitpython-build-tools
 | 
			
		||||
 | 
			
		||||
Once installed, make sure you are in the virtual environment:
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    source .env/bin/activate
 | 
			
		||||
 | 
			
		||||
Then run the build:
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31865 --library_location .
 | 
			
		||||
 | 
			
		||||
Sphinx documentation
 | 
			
		||||
-----------------------
 | 
			
		||||
 | 
			
		||||
Sphinx is used to build the documentation based on rST files and comments in the code. First,
 | 
			
		||||
install dependencies (feel free to reuse the virtual environment from above):
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    python3 -m venv .env
 | 
			
		||||
    source .env/bin/activate
 | 
			
		||||
    pip install Sphinx sphinx-rtd-theme
 | 
			
		||||
 | 
			
		||||
Now, once you have the virtual environment activated:
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    cd docs
 | 
			
		||||
    sphinx-build -E -W -b html . _build/html
 | 
			
		||||
 | 
			
		||||
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
 | 
			
		||||
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
 | 
			
		||||
locally verify it will pass.
 | 
			
		||||
		Reference in New Issue
	
	Block a user