summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2022-02-08 04:30:09 +0100
committerMartin Fischer <martin@push-f.com>2022-02-08 04:41:21 +0100
commit489fe697cc12eb7cf3e12568546b4d133538ab6b (patch)
treee503396fa582774fdb3bc211e62a04e18109a63d /README.md
parent0d57be7ea30129000db5494e1a65b79c7618eed0 (diff)
create start page
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 987c23d..6f185bf 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,15 @@
-# pydoc.dev - docs.rs for Python
+# pydoc.dev - consistent API docs for Python
-* powered by [pydoctor]
+Looking at the API documentations of Python packages can be a bit disorienting
+because they can look different from project to project (since different
+projects use different [Sphinx] themes) and because the API documentation
+often is not structured after the Python modules.
+**pydoc.dev** strives to be for Python what [docs.rs] is for Rust.
+It works by downloading the source files from the [Python Package Index],
+the API documentation is then generated with [pydoctor].
+[Sphinx]: https://www.sphinx-doc.org/
+[docs.rs]: https://docs.rs/
+[Python Package Index]: https://pypi.org/
[pydoctor]: https://github.com/twisted/pydoctor