Documentation

[apmoore1]

Create a documentation site. At the moment the requirements are:

• [x] Has an API section which is generated from the doc strings. I think the pydoc-markdown tool would be good for this. The AllenNLP library uses this tool.
• [x] A site that can be expanded so that it contains more than an API section. I think Docusaurus would be a good tool for this, as pydoc-markdown integrates with this tool. Additionally as it is based around react and markdown we are keeping the vast majority of the documentation to one language, which is markdown.
• [ ] The contributing page needs a good example on how to write documentation strings
• [x] Add cross reference code to the pydoc-markdown script

I think the doctest tool, which is in the standard python library, could be really useful to test example doc strings.

Lastly I think spaCy has a really good example of a style guide for documentation.

[apmoore1]

Add cross reference code to the pydoc-markdown script, an example of this can be found in the AllenNLP code base. By having this cross reference code it will allow users to click on custom classes/functions/modules in the documentation and be sent to the relevant documentation.

[apmoore1]

This I think would be the best plugin for performing search on the documentation site: https://github.com/lelouch77/docusaurus-lunr-search