-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation
Well, you are already in the wiki, so no need to tell you about the wiki.
Most plugins do register services. When using these services please only use the methods marked with the annotation @serviceinterface.
When developing a new plugin please mark the stable (not bound to change soon) methods with the annotation.
If you want to see/create a full (API) documentation please consider the following options:
- epydoc: Simple generation of the API docs, but does not provide a clear overview.
- Sphinx: Exhaustive documentation tool, but requires additional pages to be created. For generating a single plugin's documentation please see sphinx-apidoc.
- pydoc: Good commandline tool to quickly browse the API.
One important fact to notice about documentation is that plugins are not packages. The pluginmanager will import the plugin's root folder and add it to the system path. Hence, the documentation generators need to be told about every plugin individually.
You may edit the wiki pages directly via GitHub or on your own file system in the AMsoil repository.
The AMsoil repository includes a git-submodule in doc/wiki. When you are in this folder it appears that you are in a normal git repository. So, when changing the wiki pages in the doc/wiki folder, change into that folder and git pull, git commit and git push to update the Wiki.
The AMsoil repository only stores a reference to the current commit of the wiki repo.