Sphinx configuration for NEMSpy

[ghost]

Sphinx RST files in docs directory

I generated the docs directory using the sphinx-quickstart command
./docs

index.rst (docs homepage)

this page includes the README file using m2r2, and then includes a hidden table of contents (so the sidebar includes these links)

nemspy/docs/source/index.rst

Lines 1 to 9 in 08b454c

	.. mdinclude:: ../../README.md
	.. toctree::
	:hidden:
	nemspy.interface
	nemspy.model
	nemspy.configuration
	nemspy.utilities

example of a module page

Sphinx can use automodule, autoclass, and autofunction

nemspy/docs/source/nemspy.interface.rst

Lines 1 to 4 in 08b454c

	``ModelingSystem`` Interface
	============================
	.. automodule:: nemspy.interface

dependencies

nemspy/setup.py

Line 42 in 08b454c

'documentation': ['dunamai', 'm2r2', 'sphinx', 'sphinx-rtd-theme'],

pip install -e .[documentation]

building locally

to build the website with Sphinx, run the following:

cd docs
make html

ReadTheDocs configuration

nemspy/.readthedocs.yml

Lines 1 to 20 in 08b454c

	# .readthedocs.yaml
	# Read the Docs configuration file
	# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
	version: 2
	build:
	os: ubuntu-20.04
	tools:
	python: "3.9"
	sphinx:
	configuration: docs/source/conf.py
	python:
	install:
	- method: pip
	path: .
	extra_requirements:
	- documentation