djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
13,782 Commits 21 Branches 274 Tags 785 MiB
Commit Graph

21 Commits

Author SHA1 Message Date
Damien George 9175482f29 docs/library: Remove unnecessary "pyb." prefix on class names. 
Otherwise these classes are refered to with a double prefix, like
pyb.pyb.ADC.

Signed-off-by: Damien George <damien@micropython.org>
 2022-06-21 14:33:23 +10:00
Jos Verlinde 7f67524031 docs/library/pyb.SPI.rst: Document default for prescaler argument. 
To prevent "non-default argument follows default argument" errors.
 2022-02-09 15:06:34 +11:00
David P fdd5b18133 docs: Replace master/slave with controller/peripheral in I2C and SPI. 
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
 2021-07-18 11:19:44 +10:00
Mike Causer 47b778332a all: Replace busses with buses. 
"buses" is the widely accepted plural form of "bus".
 2021-05-20 23:22:03 +10:00
Zenix27 e76c7466b6 docs: Change `\*` to `*` in argument lists. 
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and
will render the `\` in the output if it is there, so remove it.

Fixes issue #6209.
 2020-08-21 12:24:13 +10:00
Howard Lovatt cf9be201d7 docs/library: Update pyb.SPI init method to add descr about "ti" arg. 2020-07-25 00:28:16 +10:00
Damien George 805fd0cfe6 docs/library: Remove "only" directive from all pyb module docs. 
By virtue of its name, the pyb module would only be available on a pyboard
and so does not need to have conditional "only" directives throughout its
documentation.

These conditionals were added mostly in
cfcf47c064 in the initial development of the
cc3200 port, which had the pyb module before it switched to the machine
module.  And wipy only conditionals were removed from the pyb module
documentation in 4542643025, so there's no
need to retain any more conditionals.
 2018-07-18 15:47:44 +10:00
Paul Sokolovsky 4ab3eef8d7 docs/library/pyb.SPI: init(): Describe "bits" argument. 
Based on https://github.com/micropython/micropython/pull/2210 .
 2016-09-18 21:41:21 +03:00
Paul Sokolovsky a384a53130 docs/pyb.*: Use proper class case in method headers. 
Class designator will be used as is in indexes, so must match actual class
name.
 2016-06-08 16:21:28 +03:00
Paul Sokolovsky 0a4cc24b2e docs/pyb.*: Add "currentmodule:: pyb" directive. 
Makes sure that classes described in these separate files are properly
designated as belonging to "pyb" module in indexes.
 2016-06-08 00:57:41 +03:00
Peter Hinch 6d5a549067 docs: Mention that pyb.SPI constructor accepts "X" and "Y" arguments. 2016-03-17 20:19:08 +00:00
danicampora 4542643025 docs: Update all WiPy docs to reflect the new API. 2015-10-17 23:29:04 +02:00
Daniel Campora aba75e1233 cc3200: New SPI API. 2015-09-16 10:10:33 +02:00
Daniel Campora 34c290b678 cc3200: Rename SPI nss param to cs. 
The nss param in the pyboard has a different meaning that doesn't
apply to the WiPy.
 2015-08-16 20:17:55 +02:00
Daniel Campora c6926c374d cc3200: Make I2C and SPI API the same as in stmhal. 2015-08-02 20:22:15 +02:00
Daniel Campora cfcf47c064 docs: Add initial draft documentation for the WiPy. 
This makes all common files "port-aware" using the .. only directive.
 2015-06-10 23:37:56 +02:00
Damien George b66a31c42c stmhal: Allow SPI.init to specify prescaler directly; improve SPI docs. 2014-12-08 21:34:07 +00:00
Damien George 8e701604d5 docs: Add links from quickref to pyb classes. 2014-11-04 18:25:20 +00:00
Damien George 6e6dfdc56b docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00
Damien George a58713a899 docs: Cleanup and update some docs. 2014-10-31 22:21:37 +00:00
Damien George 88d3054ac0 docs: Import documentation from source-code inline comments. 
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
 2014-10-31 01:37:19 +00:00