Update docs and add doctest loading mechanism#467

Merged

althonos merged 23 commits intomasterfrom

Mar 27, 2021

Commits on Mar 27, 2021

Add disclaimer about the `writeable` parameter of `fs.open_fs`
althonos
committed
Add a loader for doctests to the unittest suite
althonos
committed
Fix docstrings of various `fs` submodules to pass the doctests
althonos
committed
Add some more examples opening a FTPFS in `fs.ftpfs` module
althonos
committed
Add `TempFS.close` docstring with a warning about the `auto_clean` parameter
althonos
committed
Remove unused imports in `fs.path` and `tests.test_doctest`
althonos
committed
Remove empty line from `fs.walk.Walk.bind` docstring
althonos
committed
Add a workaround for `pytest` not supporting the `load_tests` protocol
althonos
committed
Fix type annotation and docs of `temp_fs` parameter of archive FS
althonos
committed
Document some exceptions expected on edge cases of `fs.base.FS` methods
althonos
committed
Ignore type-checking branches when measuring coverage
althonos
committed
Add overloaded annotations of `epoch_to_datetime` to `fs.time`
althonos
committed
Remove compatibility code from `tests.test_doctest`
althonos
committed
Add some examples showing how to build a `TempFS`
althonos
committed
Rewrite docstrings of some private helpers in `doctest` format so they are tested
althonos
committed
Improve `Info.is_writable` to document the `_write` key of every namespace
althonos
committed
Standardize behaviour of `removetree("/")` and add test case to `FSTestCase`
althonos
committed
Fix `WrapFS.removetree` so that it respects the root path semantics
althonos
committed
Explicitly check the *basic* namespace is always returned by `FS.getinfo`
althonos
committed
Deprecate `FS.getbasic` since it is superseded by `FS.getinfo`
althonos
committed
Document more of the expected exceptions in `fs.base.FS` interface
althonos
committed
Illustrate how to use a proxy server in `FTPFS`
althonos
committed
Update `CHANGELOG.md` with changes introduced in #467
althonos
committed