diff options
| l--------- | README.md | 9 | ||||
| -rw-r--r-- | docs/deploy.sh | 3 | ||||
| -rw-r--r-- | docs/source/conf.py | 7 | ||||
| -rw-r--r-- | docs/source/index.rst | 3 | ||||
| -rw-r--r-- | docs/source/readme.md | 8 |
5 files changed, 25 insertions, 5 deletions
@@ -1 +1,8 @@ -docs/source/index.rst
\ No newline at end of file +# Smarker + +Smarker is a system designed to help module organisers mark python programming assessments. +Is is an expandable system, which produces reports about a student's code in many different +formats. + +- [Read the documentation](http://smarker.eda.gay/) +- [Get the source code](https://github.com/jwansek/Smarker) [Mirror](https://git.eda.gay/Smarker/files.html) diff --git a/docs/deploy.sh b/docs/deploy.sh index d43e998..91ca207 100644 --- a/docs/deploy.sh +++ b/docs/deploy.sh @@ -3,4 +3,5 @@ scp build.tar.gz eden@vps.eda.gay:/home/eden/SmarkerDocs/build.tar.gz rm build.tar.gz ssh eden@vps.eda.gay "rm -rf /home/eden/SmarkerDocs/build/" ssh eden@vps.eda.gay "tar xvf /home/eden/SmarkerDocs/build.tar.gz -C /home/eden/SmarkerDocs" -ssh eden@vps.eda.gay "rm /home/eden/SmarkerDocs/build.tar.gz"
\ No newline at end of file +ssh eden@vps.eda.gay "rm /home/eden/SmarkerDocs/build.tar.gz" +ssh eden@vps.eda.gay "chmod 755 -R /home/eden/SmarkerDocs/build/"
\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index fd85d58..bef233e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,7 +28,12 @@ author = 'Eden Attenborough' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.coverage', + 'sphinx.ext.napoleon', + "sphinx_mdinclude" +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/source/index.rst b/docs/source/index.rst index c238253..4da39e2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,4 @@ -Welcome to Smarker's documentation! -=================================== +.. mdinclude:: readme.md Setting up ---------- diff --git a/docs/source/readme.md b/docs/source/readme.md new file mode 100644 index 0000000..419bad3 --- /dev/null +++ b/docs/source/readme.md @@ -0,0 +1,8 @@ +# Smarker + +Smarker is a system designed to help module organisers mark python programming assessments. +Is is an expandable system, which produces reports about a student's code in many different +formats. + +- [Read the documentation](http://smarker.eda.gay/) +- [Get the source code](https://github.com/jwansek/Smarker) [Mirror](https://git.eda.gay/Smarker/files.html) |