Commit Graph

778 Commits

Author SHA1 Message Date
Ben Nuttall
9af06fbfa3 Reword robot class docstrings 2017-07-26 12:51:02 +01:00
Ben Nuttall
550c167056 Add Pi Zero W screenshot to pinout docs page 2017-07-21 10:37:59 +01:00
Ben Nuttall
fbdecd5c61 Reword remote gpio sentence to make sense with the page title 2017-07-21 10:33:39 +01:00
Ben Nuttall
e748b3dc5e Ensure port number example is in backticks 2017-07-21 10:31:59 +01:00
Ben Nuttall
72d34eee0f Add pinout screenshot to docs page 2017-07-21 10:30:12 +01:00
Ben Nuttall
cfe57f94af Use Pi 3 as pinout example 2017-07-21 10:26:49 +01:00
Ben Nuttall
934b2815c9 Change copyright to 2015-2017 2017-07-21 10:19:37 +01:00
Ben Nuttall
4f063bc40a Update some links to https 2017-07-21 10:18:06 +01:00
Ben Nuttall
696c72f1e7 Fix typo in url 2017-07-21 10:11:07 +01:00
Ben Nuttall
3f2f335ad8 Reword remote pins -> remote gpio 2017-07-17 02:18:41 +01:00
Ben Nuttall
c915cf1c5b Add missing words 2017-07-17 02:16:50 +01:00
Ben Nuttall
21f322c4d2 BlueDot -> BlueDot LED 2017-07-17 02:11:55 +01:00
Ben Nuttall
22fb913f41 Merge branch 'master' into pinout-man 2017-07-17 02:07:01 +01:00
Ben Nuttall
220da280ba Add more advanced and remote recipes 2017-07-17 02:03:29 +01:00
Ben Nuttall
53f1837ec7 Add Stewart Adcock to contributors 2017-07-17 01:19:57 +01:00
Ben Nuttall
b967afdd8d Add thanks to Stewart Adcock 2017-07-17 01:15:00 +01:00
Dave Jones
d609df4297 Highlight the right line in rgbled_pot_2 recipe 2017-07-16 23:49:42 +01:00
Dave Jones
db4c93940e Get the version right... 2017-07-16 23:10:52 +01:00
Dave Jones
afa23949e8 Turn pinout docs into man-page
Stops lintian whinging about missing man-pages
2017-07-16 23:09:29 +01:00
Dave Jones
f288993437 Write changelog and bump release for 1.4 2017-07-16 20:45:08 +01:00
Dave Jones
957bb788ea Fix Raspbian x86 link 2017-07-16 17:25:24 +01:00
Ben Nuttall
319169e9da Add print temperature to CPUTemperature example and add temperature property to docs 2017-07-16 12:21:09 +01:00
Ben Nuttall
6115c78730 Complete PC/Mac installation instructions and move to remote gpio setup page 2017-07-16 12:01:45 +01:00
Ben Nuttall
e4038c5ad9 Rename x86 OS 2017-07-16 11:35:28 +01:00
Ben Nuttall
b614fdc4f9 Merge pull request #576 from waveform80/docs-config
Docs config
2017-07-16 12:23:49 +02:00
Dave Jones
69970dfc4b "only" is a Sphinx extension too ... apparently
Doesn't render in GitHub, and setup.py whinges about it. Also about the
duplicate "Development" anchor (due to the Development heading). All
warnings now gone from setup.py, but we may need to find another means
of excluding the badges from offline docs ...
2017-07-15 22:30:08 +01:00
Dave Jones
d3ee0c0102 Switch pin numbering / import ordering
Makes more sense, slightly better print layout
2017-07-14 23:07:32 +01:00
Dave Jones
4cc4b1c132 Restructure index
Move the API to the end, recipes all grouped together up-front (with
remote GPIO setup just before the remote GPIO recipes). Tweak some
headings so everything looks a little more consistent in the (now
shorter) ToC.

Also added module index tags.
2017-07-14 21:46:27 +01:00
Dave Jones
120a30a951 Stop setup.py whinging
Apparently :doc: is a Sphinx extension and when setup.py checks for
strict ReST adherence, this fails the test. May need a work-around for
..only in the header yet.
2017-07-14 21:45:12 +01:00
Dave Jones
401f3a4437 Fix attribute link 2017-07-14 21:44:40 +01:00
Dave Jones
cb4276e897 Split Notes into FAQ and Recipes
Notes was always a bit of a "vague" section and half of it felt like
FAQs. Hopefully this is a little more consistent
2017-07-14 21:07:26 +01:00
Dave Jones
366c22e637 First stab at a FAQ 2017-07-14 16:57:06 +01:00
Dave Jones
9ed3a19a8e Update docs config
Add epub output, fix PDF output to include page-numbers in links (for
printed output), reduce the (now ridiculous) length of the ToC by
dropping it to one level, add numbering to chapters
2017-07-14 16:57:06 +01:00
Dave Jones
978f8175da Merge pull request #569 from waveform80/pin-factory-docs
Fix #568, fix #572, fix #565
2017-07-14 16:47:55 +01:00
Dave Jones
b462b5f84a Remove all the remaining pin.address stuff
... again?
2017-07-14 16:11:40 +01:00
Dave Jones
a0d784082d Fix #565
Add mock pins docs and tidy up some other bits of the pins docs
2017-07-14 15:11:59 +01:00
Dave Jones
4009bf39df Fix #572
Tempted to add a FAQ entry about this anyway as it's come up multiple
times
2017-07-14 14:29:36 +01:00
Dave Jones
13f5e5ea3b Fix old references to PiGPIOPin 2017-07-14 14:21:08 +01:00
Dave Jones
a68610d737 Minor formatting fixes 2017-07-14 14:11:32 +01:00
Dave Jones
d502dbc8e8 Stupid mistakes...
Spotted by @lurch's eagle eyes as usual :)
2017-07-14 14:02:03 +01:00
Dave Jones
49d3bbc1da Consistency in factory references 2017-07-14 14:01:39 +01:00
Dave Jones
b2e4237a57 Correct remote GPIO recipes 2017-07-14 14:01:29 +01:00
Dave Jones
eafae5c31a Fix #568
Update examples in pin factory docs so they work correctly.
2017-07-14 13:51:29 +01:00
Dave Jones
93a1f529e8 Merge pull request #574 from waveform80/pin-factory-param
Fix #279
2017-07-14 13:38:35 +01:00
Dave Jones
9fdc093837 Add pin_factory to all relevant class docs
Also tell a whole load of lies about what's a keyword-only arg. In the
vast majority of cases, pin_factory (and other args) *aren't*
keyword-only ... but we'd really like them to be, it's just difficult
while maintaining py2 compatibility.
2017-07-14 11:01:02 +01:00
Dave Jones
8958874a77 Add pin_factory param to all devices
And some docs ...
2017-07-14 10:44:24 +01:00
Ben Nuttall
5a07b545e2 Rename x86 distro 2017-07-10 17:44:47 +01:00
Dave Jones
1ca017fc6d Make mock constructor consistent 2017-07-05 20:17:57 +01:00
Dave Jones
c820636fcb Fix #279 once and for all (ha! ;)
This implements the proposal discussed in the re-opened #279 to add a
pin_factory argument at the device level and remove the ability to
specify a pin instance to device constructors (they now only accept a
pin specification).

Note: there's still a couple of bits to tidy up (tests on "real" Pis,
and pin_factory.release_all needs refinement) but the test suite is now
at least capable of passing on a PC.
2017-07-04 00:26:41 +01:00
Ben Nuttall
448feaf68f Correct StatusBoard max strip numbers in docstring 2017-07-03 12:30:58 +01:00