Improve documentation

[johannesjh]

in this branch: feature/refs-42-improve-documentation

[johannesjh]

I started working on the documentation in the branch feature/refs-42-improve-documentation.

@tarioch : what do you think about the recommendation I gave, i.e., to apply the decorators to subclasses of importers in order to ease unittesting? That's how I have been using the smart_importers up until now.

Note: To keep things simple, I moved documentation regarding alternative ways applying the decorators to a separate file docs/Applying_the_Decorators.rst. I still need to figure out how link to this other file, I am new to the .rst syntax.

[tarioch]

I actually only use the smart importer in my import.config that way my importer code doesn't have any dependency on it and can be easily unit tested.

[varac]

Please improve examples and documentation, I am fighting for hours now how to get the smart_importer working with my own importer.

[johannesjh]

Update to this ticket: The documentation feature branch feature/refs-42-improve-documentation has long been merged.

I additionally updated the documentation as follows in the doc branch, with according pull request https://github.com/beancount/smart_importer/pull/99

• I quickly fixed some broken URLs in the documentation,
• and I removed old obsolete plantuml diagram

[johannesjh]

doc branch is merged. I will close this issue.