Yonatan Goldschmidt
9521399044
docs/uos: Document extra requirements on stream objs passed to dupterm.
This is only correct for the extmod/uos_dupterm.c implementation however,
as e.g cc3200 implementation does the mp_load_method() itself, and anyway
requires `read` instead of `readinto`.
6 years ago
Damien George
ab02abe96d
docs/uos: Make it clear that block device block_num param is an index.
6 years ago
Tom Collins
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
7 years ago
Damien George
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
7 years ago
Damien George
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
7 years ago
Paul Sokolovsky
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
7 years ago
Damien George
e30ba2f1c7
docs/library: Add description of "index" parameter to uos.dupterm().
8 years ago
Paul Sokolovsky
465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
7 years ago
Paul Sokolovsky
f8ac28964d
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.
7 years ago
Paul Sokolovsky
e91b1cdae3
docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.
This patch also unconditionalizes uos.dupterm(), though exact interface
and semantics is yet to be defined.
8 years ago
Paul Sokolovsky
1ce44f3046
docs/uos: Deconditionalize, remove minor port-specific details.
For a couple of ports, there was information which directory is set
as current after boot. This information doesn't belong to "uos" module,
and is moved to boards' references (which actually already contained
information on which directory is chosen for boot, even if without
explicit mentioning that it becomes current directory, which is now
done).
8 years ago
Damien George
6d221fe284
docs/library/uos: Add description of uos.ilistdir() function.
8 years ago
Paul Sokolovsky
a0fb360f1b
docs/library/uos: urandom: Generalize description.
Don't give a guarantee of HW RNG, only a possibility of its usage.
8 years ago
Paul Sokolovsky
906d58f6f2
docs/uos: De-conditionalize statvfs() description.
It's a standard function, and it's already described (in the library
intro) that for any given port, any function may be missing.
8 years ago
Paul Sokolovsky
ee3615d800
docs/uos: Remove mention of uos.sep.
MicroPython guarantees '/' to be a path separator, so extra constant taking
precious ROM space are not needed. MicroPython never had such constant, only
one vendor port had it (now unmaintained).
8 years ago
Alex March
00c1fc6d77
docs/uos: Add uos.statvfs() documentation.
8 years ago
Mike Causer
ce166e6b68
docs: Spelling mistakes
8 years ago
Damien George
e0f7e001e8
docs: Fix uos and utime heading underlines to be the correct length.
Otherwise Sphinx gives a warning.
9 years ago
Paul Sokolovsky
351ec6d4ab
docs/library: "os" module is actually "uos".
9 years ago
Paul Sokolovsky
69b702276b
docs/os: Change wording to be a bit more port-neutral.
9 years ago
danicampora
4542643025
docs: Update all WiPy docs to reflect the new API.
9 years ago
Daniel Campora
cfcf47c064
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
10 years ago
Steve Zatz
c7df9c6c47
stmhal: Add os.rename function.
10 years ago
Damien George
a58713a899
docs: Cleanup and update some docs.
10 years ago
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.
10 years ago