moe-serifu-circle / moe-serifu-agent

Anime-themed personal assistant and goal-oriented intelligent agent
GNU Lesser General Public License v3.0
42 stars 7 forks source link

Create docs #116

Closed jghibiki closed 5 years ago

jghibiki commented 5 years ago

Creates a base docs setup in sphinx. Mostly just stubs for now. I will begin flushing them out once this is merged.

jghibiki commented 5 years ago

They are generated via the module doc tags. sphinx has a script that scans the api and generates an autodoc skeleton. When the doc tags are updated, and the docs are rebuilt, the skeleton just says where each module should go. The api/ dir will need to get re-generated periodically if there are files added/removed. It is a trivial step.

dekarrin commented 5 years ago

Had offline conversation to discuss this. I was unclear before. My understanding is now as follows:

As it turns out, these are template files that are required by the generation of documentation, but are not themselves generated by that step. They will not change frequently; only when we need to update the styling/layout of the final documentation.