diff --git a/docs/_static/style.css b/docs/_static/style.css index b2d973b..80e62f2 100644 --- a/docs/_static/style.css +++ b/docs/_static/style.css @@ -31,3 +31,15 @@ .wy-side-nav-search > a img.logo, .wy-side-nav-search .wy-dropdown > a img.logo { width: 100px !important; } + +.wy-nav-side { + background-color: #2c3e50; +} + +.wy-side-nav-search { + background-color: #2c3e50; +} + +.wy-menu-vertical p.caption { + color: #fff; +} diff --git a/docs/conf.py b/docs/conf.py index fd11fd8..8f6a7da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,7 +71,7 @@ # # The short X.Y version. with open('../package.json') as package: - version = json.load(package)['version'] + version = 'v' + json.load(package)['version'] # The full version, including alpha/beta/rc tags. release = version diff --git a/docs/install.rst b/docs/install.rst index 53acded..8300ab5 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,16 +1,18 @@ Installation ============= -The CodeGrade filesystem has to be installed and both the ``cgfs`` and the +The CodeGrade Filesystem has to be installed and both the ``cgfs`` and the ``cgapi-consumer`` helper program must be available from the user's ``$PATH`` to -successfully install and use the CodeGrade editor plugins. +successfully install and use the CodeGrade editor plugins. This should be +automatically done when installing the CodeGrade Filesystem with the official +installer. -Installing the CodeGrade Atom Plugin (or CodeGra.Atom) can be done via the +Installing the CodeGrade Atom Plugin (*or CodeGra.Atom*) can be done via the command line or using the Atom GUI. Installation via the command line is done with the following command: ``apm install codegrade-atom``. -Installing using the +Installing using the Atom GUI can be done in the ``Install`` tab in the ``Settings`` or ``Preferences`` screen. Search for ``codegrade-atom`` in the search dialog and press ``Install`` to install the plugin. diff --git a/docs/usage.rst b/docs/usage.rst index f15773e..c8a695e 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -8,27 +8,27 @@ CodeGrade filesystem: +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ | Command | ``--fixed`` | Description | +======================================+=============+==========================================================================================+ -| codegrade:edit-line-comment | ✓ | Edit the comment(s) on the line(s) with a cursor on them. | +| codegrade:edit-line-comment | ✓ | Edit the comment(s) on the line(s) with a cursor on them. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:delete-line-comment | ✓ | Delete the comment(s) on the line(s) with a cursor on them. | +| codegrade:delete-line-comment | ✓ | Delete the comment(s) on the line(s) with a cursor on them. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:open-rubric-editor | ✗ | Edit the rubric of the assignment of the current file. | +| codegrade:open-rubric-editor | ✗ | Edit the rubric of the assignment of the current file. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:open-rubric-selector | ✗ | Open the rubric selector file to fill in the rubric for the current submission. | +| codegrade:open-rubric-selector | ✗ | Open the rubric selector file to fill in the rubric for the current submission. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:edit-geedback | ✗ | Edit the current submission's global feedback. | +| codegrade:edit-geedback | ✗ | Edit the current submission's global feedback. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:edit-grade | ✗ | Edit the current submission's grade. | +| codegrade:edit-grade | ✗ | Edit the current submission's grade. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:select-rubric-item | ✗ | Select the rubric item that the cursor is on, deselecting any other item in the same group. | +| codegrade:select-rubric-item | ✗ | Select the rubric item that the cursor is on, deselecting other items in the same group. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:goto-prev-rubric-header | ✗ | Go to the previous header in a rubric file. | +| codegrade:goto-prev-rubric-header | ✗ | Go to the previous header in a rubric file. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:goto-next-rubric-header | ✗ | Go to the next header in a rubric file. | +| codegrade:goto-next-rubric-header | ✗ | Go to the next header in a rubric file. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:goto-prev-rubric-item | ✗ | Go to the previous item in a rubric file. | +| codegrade:goto-prev-rubric-item | ✗ | Go to the previous item in a rubric file. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ -| codegrade:goto-next-rubric-item | ✗ | Go to the next item in a rubric file. | +| codegrade:goto-next-rubric-item | ✗ | Go to the next item in a rubric file. | +--------------------------------------+-------------+------------------------------------------------------------------------------------------+ .. note:: The ``--fixed`` flag when mounting is required to use line comment commands.