From 489fe697cc12eb7cf3e12568546b4d133538ab6b Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Tue, 8 Feb 2022 04:30:09 +0100 Subject: create start page --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3