search

BishoyAbdelmalik / Clippy-Server

The server (desktop application) for clippy the clipboard and remote control application.
MIT License
0 stars 0 forks source link

Generate inline documentation #1

Open Arian-D opened 3 years ago

Arian-D commented 3 years ago

Use sphinx to get inline documentation.

Arian-D commented 3 years ago

Sphinx can now generate documentation from README.md and TODO.md. From e2d7b2a1e9f9b63bb765e2c3189ed0759fb95d6c it can also generate inline code, but some of the stuff need to be explicit, and Bishoy's winrt calls might need to be documented. clippy-server.pdf. is a demo of what it looks like, and it needs to be done better.

@alicebalayan will most likely have to see how to structure this and add a better theme.

Arian-D commented 3 years ago

There is a package to add type hints to the docs. I'll have to add that too

Arian-D commented 3 years ago

@alicebalayan https://sphinxthemes.com/ has a bunch. Let me know which one you like more here