Documentation Updates

[HannahSi]

Below are some updates and improvements that can be made to the aguaclara documentation site:

• Replace "View Page Source" in the top right of every page with an "Edit on Github" link that leads to this repo. See this thread for how.
• In the Continuous Integration via Github Actions section of the Developer Guide, update the "Trigger" for the Documentation workflow from "Push to master branch" to "Publishing of release"
• Find out to how change the version in the top left corner of the documentation page from "EXPERIMENTAL" to the package's latest version.
• In addition to the API Reference and Developer Guide, there should be a user guide with explanations and examples of how to use the package for various purposes. Some places to start:
  • The 4 main functionalities listed on the homepage
  • Ask researchers or RAs for ideas or examples to pull from past research reports
  • Demonstrate some features from each module

[annabel48lin]

• Typo in developer guide in Sphinx Documentation - Automated Documentation: "correst RST"
• For the testing section, it would be helpful to add tag -s to display anything that you print (for checking values, etc while debugging)

[HannahSi]

• Make the note "For more guidance on using Git in the command line, see the AguaClara Tutorial Wiki" or the link in the note easier to notice/find (e.g. it could go in the Setting Up Your Local Environment section)
• Maybe add guidance on using Github Desktop for git commands that aren't obvious

[annabel48lin]

• Replace links in the tutorial to the colab links to the ones that I have access to in the drive
• Add links to the API in colab tutorials to reinforce the idea of checking the API for methods
• Update link to Linear Regression example of Data Analysis (is broken right now, file location here)

[annabel48lin]

• typo in python packages tutorial - sig figs "set_fig_figs(n)"

[annabel48lin]

add section for ac tutorial: how to look for / read documentation

[HannahSi]

Change these lines:

aguaclara/docs/source/conf.py

Lines 27 to 28 in cc40815

	import os
	version = os.getenv("TRAVIS_TAG", "EXPERIMENTAL")

to something like this (see example from https://github.com/pythonarcade/arcade/blob/maintenance/doc/conf.py):

from version import VERSION
version = VERSION
release = VERSION

so that the version number on our documentation site says "latest" or a number instead of "EXPERIMENTAL"