Updated Documentation

[Abdullahshah]

Version 2 (current):
The api-docs now uses a new recursive way to find source code and build summary pages for them for our documentation. The only change moving forward would be to add a quick description in the __init__.py files for each module. An example would be:
__init__.py: """ A quick description of the module """

Sphinx auto-doc will take this string and set it as a quick description for the module's page.

To generate the documentation, navigate to eva/api-docs/ and run make clean && make html. This will create the HTML files under _build which you can use to view the changes locally. It also generates the .rst files under api-docs/_autosummary which are used by Spinx to generate the HTML content

Version 1 (OLD):
Created script generate_documentation.py which creates the documenation .rst using the jinja templating engine.
(this script can only be run from the root directory -> but there is a check for this in the script)

To test these changes, enter the conda environment, navigate to the directory api-docs and run make html. This will generate a local copy of the website under the directory _build which can be opened in the browser.

[gaurav274]

Please also add the installation dependencies to build using sphinx .

[Abdullahshah]

No longer need generate_documentation.py. Deprecating that script for now but may need it later if api-docs needs further changes.

[Abdullahshah]

Check the Conversation tab for updates to documentation process.

[gaurav274]

@Abdullahshah Any updates on this PR? Let's merge this as early as possible.

[xzdandy]

Add sphinx and sphinx_rtd_theme to conda environment file.

[gaurav274]

LGTM