@@ -6,10 +6,6 @@ Introduction
6
6
:target: https://circuitpython.readthedocs.io/projects/sdcard/en/latest/
7
7
:alt: Documentation Status
8
8
9
- .. image :: https://badges.gitter.im/adafruit/circuitpython.svg
10
- :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
11
- :alt: Gitter
12
-
13
9
.. image :: https://img.shields.io/discord/327254708534116352.svg
14
10
:target: https://adafru.it/discord
15
11
:alt: Discord
@@ -64,10 +60,49 @@ Contributions are welcome! Please read our `Code of Conduct
64
60
<https://github.com/adafruit/Adafruit_CircuitPython_sdcard/blob/master/CODE_OF_CONDUCT.md> `_
65
61
before contributing to help this project stay welcoming.
66
62
67
- API Reference
68
- =============
63
+ Building locally
64
+ ================
65
+
66
+ To build this library locally you'll need to install the
67
+ `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
68
+
69
+ .. code-block :: shell
70
+
71
+ python3 -m venv .env
72
+ source .env/bin/activate
73
+ pip install circuitpython-build-tools
74
+
75
+ Once installed, make sure you are in the virtual environment:
76
+
77
+ .. code-block :: shell
78
+
79
+ source .env/bin/activate
80
+
81
+ Then run the build:
82
+
83
+ .. code-block :: shell
84
+
85
+ circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sd --library_location .
86
+
87
+ Sphinx documentation
88
+ -----------------------
89
+
90
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
91
+ install dependencies (feel free to reuse the virtual environment from above):
92
+
93
+ .. code-block :: shell
94
+
95
+ python3 -m venv .env
96
+ source .env/bin/activate
97
+ pip install Sphinx sphinx-rtd-theme
98
+
99
+ Now, once you have the virtual environment activated:
100
+
101
+ .. code-block :: shell
69
102
70
- .. toctree ::
71
- :maxdepth: 2
103
+ cd docs
104
+ sphinx-build -E -W -b html . _build/html
72
105
73
- api
106
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
107
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
108
+ locally verify it will pass.
0 commit comments