Updates the tutorial and other documentation

README.rst

@@ -3,7 +3,7 @@ gpu_tracker
 ###########
 Description
 -----------
-The ``gpu_tracker`` package provides a ``Tracker`` class that tracks (profiles) the usage of compute time, maximum RAM, and maximum GPU RAM.
+The ``gpu_tracker`` package provides a ``Tracker`` class and a commandline-interface that tracks (profiles) the usage of compute time, maximum RAM, and maximum GPU RAM.
 The compute time is a measurement of the real time taken by the task as opposed to the CPU-utilization time.
 The GPU tracking is for Nvidia GPUs and uses the ``nvidia-smi`` command, assuming the Nvidia drivers have been installed.
 Computational resources are tracked throughout the duration of a context manager or the duration of explicit calls to the ``start()`` and ``stop()`` methods of the ``Tracker`` class.

docs/cli.rst

@@ -3,7 +3,7 @@ CLI
 The ``gpu-tracker`` command-line interface allows tracking computational-resource-usage of an arbitrary shell command.
 For example, one may want to profile a command that runs a script or a command ran in a high-performance-computing job.
 Below is the help message shown from ``gpu-tracker --help``.
-See the :ref:`tutorial-label` for examples of using the CLI.
+See the CLI section of the :ref:`tutorial-label` for examples of using the CLI.
 
 .. literalinclude:: ../src/gpu_tracker/__main__.py
     :start-at: Usage:

docs/conf.py

@@ -51,6 +51,7 @@ def setup(app):
 
 autodoc_typehints = 'both'
 autoclass_content = 'both'
+autodoc_member_order = 'bysource'
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']