update docs readme

[paaige]

Closes #863

[paaige]

also do we still need docs/Makefile? it only really executes one command, which we could just put in build_docs.py (or alternatively we could move all the sphinx-apidoc calls from build_docs to the makefile?)

Just noticed this comment from the issue, i'll update wrt it

[bharat-thotakura]

Partial review: changes LGTM (pending pandocs -> pandoc).

Will leave final approval to @stephanielee9 or @richrines1

[paaige]

also do we still need docs/Makefile? it only really executes one command, which we could just put in build_docs.py (or alternatively we could move all the sphinx-apidoc calls from build_docs to the makefile?)

Moved to build_docs and removed the makefile

[richrines1]

we should turn this into a list and remove the shell=True:

Suggested change

	f"sphinx-apidoc -f -o source {path} {path}/*_test.py", shell=True, cwd=docs_dir
	["sphinx-apidoc", "-f" ,"-o", "source", path, f"{path}/*_test.py"], cwd=docs_dir

also should we add the "-W" option so the check fails on warnings? (and ditto for the sphinx-build line below)

[paaige]

That's not a flag for sphinx-apidoc but will add it for the build command

[richrines1]

this lgtm % formatting! leaving for @stephanielee9 for final approval though because she's more familiar with the docs infrastructure

[stephanielee9]

lgtm! from what I can tell, the docs still build locally fine with the make file and readthedocs doesn't use it either