search

itsjohncs / phial

A Python microframework for building static sites. Will not be completed.
BSD 2-Clause "Simplified" License
4 stars 0 forks source link

Add documentation for API. #18

Open itsjohncs opened 10 years ago

itsjohncs commented 10 years ago

Can't do this until we have a stable API. When it comes time to do this though, dogfooding and using Phial to generate the docs would be interesting.

itsjohncs commented 10 years ago

Daydreamed a bit about this and came up with some cool ideas. I should do everything I can to make the API as easy to search through as possible, going as far as writing my own search engine if necessary. There's also a number of tools out there for accessing documentation. I should make everything exportable to those tools as well. I think "Phial as a build system" would help with this, though I'm still not sure how much I want to promote such an idea.

In fact, I'm fairly sure I don't want to promote that at all. There are other tools that are going to be much better at doing things like publishing. I'd rather not have Phial try to do that.

itsjohncs commented 10 years ago

I can try to contribute to https://github.com/Thibaut/devdocs once things are settled. It looks like I'll need some popularity to get my patch accepted though. I'll also need a logo...