Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 4.71 KB

README.md

File metadata and controls

104 lines (78 loc) · 4.71 KB
Raw

py.wtf

All Contributors pre-commit.ci status

Wat dis?

It's autogenerated reference docs for PyPI packages. See for yourself at py.wtf.

Butwhy

py.wtf aims to be an absolutely 0 effort reference doc hosting site for all packages on PyPI: No setting up doc building pipelines, domains, hosting providers.

  • Read the Docs is very nice, but it has a tutorial. py.wtf just exists.
    • It's still very nice for putting together more than just reference docs.
  • MkDocs is very nice, but it has a tutorial. py.wtf just exists.
    • It's still very nice because you can write your docs in markdown and the output is pretty.
  • Pycco is nice and its tutorial is pretty short too! But py.wtf just exists.

py.wtf statically (i.e. without installation) analyzes Python projects to extract modules, functions, classes, variables, their types, and docstrings. Then cross-references these across projects to display them in a single, integrated, and searchable web page.

As such, it is impossible for project authors to configure py.wtf, apart from changing docstrings themselves. This brutal inflexibility allows py.wtf to stay relatively simple1, and attempt to do one thing, well.

Installation

Just don't.

Hacking

Please do. Python 3.12, Node 18.

cd py.wtf
pipx run hatch shell
YOUR_FAVORITE_PROJECT=click
py-wtf index --project-name $YOUR_FAVORITE_PROJECT www/public/_index/
cd www
npm install
npm run dev

Acknowledgements

This project draws inspiration heavily from the following excellent software:

Thanks goes to these wonderful people (emoji key):


Zsolt Dollenstein
💻 🚇 🎨
Zoltán Nagy
💻 🎨
Adrienn Éva Csengeri-Pap
💻 🎨
Anuj Upadhyaya
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

py-wtf is distributed under the terms of the MIT license.

Footnotes

  1. except for the parts that deal with reStructuredText and markdown ↩