vseloved / cl-nlp

Common Lisp NLP toolset
Other
219 stars 28 forks source link

Add documentation #23

Closed dmsurti closed 9 years ago

dmsurti commented 9 years ago

This PR adds documentation infrastructure using readthedocs for hosting the documentation and mkdocs for markdown support.

  1. Adds documentation for getting started and POS tagger samples.
  2. Adds readthedocs badge to Readme.
  3. Ignores the site/ dir generated by mkdocs.

    Why mkdocs and readthedocs?

Very easy to set up, write docs and test them locally before submitting for changes.

Assumptions

Reference: https://docs.readthedocs.org/en/latest/getting_started.html#import-your-docs