Hosted documentation

[detly]

I'd like to be able to read the API documentation somewhere on the web, so I don't have to install Sphinx, Breathe, themes, etc. and set up a local webserver. Could it be put up on eg. readthedocs or as Github pages or somewhere similar?

[tomghuang]

Hi @detly, I'm currently changing the whole documentation system. My plan is to upload the generated documentation to the official website, so that developers can always browse the latest API reference whenever we commit document modifications.

I'm also trying to figure out how to automatically download all the necessary tools to a local, sub-directory under the repository, and generate the documents with these tools, even when you already have these tools installed in the system. It is very useful when we need version X of a tool while the system has version Y. With this mechanism, we can guarantee that we always use the right toolchain to generate documents.

[detly]

That sounds great, I'll wait for that then.

I'm also trying to figure out how to automatically download all the necessary tools to a local, sub-directory

Could be a job for Docker.