Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation text and style #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@
with open("../codegra.el", 'r') as f:
data = f.read()
needle = '\n;; Version: '
version = data[data.find(needle) + len(needle):].split()[0]
version = 'v' + data[data.find(needle) + len(needle):].split()[0]

# The full version, including alpha/beta/rc tags.
release = version

Expand Down
6 changes: 4 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@ Installation
=============
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.

After the Filesystem is successfully installed clone
`this <https://github.com/CodeGra-de/CodeGra.el>`__ repository to a
local folder (using the ``git clone git@github.com:CodeGra-de/CodeGra.el.git``
commmand) and add this folder to your ``load-path`` in emacs.
command) and add this folder to your ``load-path`` in emacs.

After doing this you can add ``(require 'codegrade)`` to your emacs config.

Expand Down