From 4305406c3f93ce1727c9980cb7be7709538cbaa1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Hrb=C3=A1=C4=8D?= <david@hrbac.cz>
Date: Thu, 25 Oct 2018 12:47:32 +0200
Subject: [PATCH] Upgraded to mkdocs 1.0.4
---
.gitignore | 1 +
README.md | 13 ++++++++++++-
mkdocs.yml | 7 ++++---
requirements.txt | 15 +++++++++++++++
4 files changed, 32 insertions(+), 4 deletions(-)
create mode 100644 requirements.txt
diff --git a/.gitignore b/.gitignore
index 0682751bb..fd2940e4f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
site/
scripts/*.csv
+venv/
diff --git a/README.md b/README.md
index 82d31ceb8..686439b27 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,17 @@
# User documentation
-This is project contain IT4Innovations user documentation source.
+This project contains IT4Innovations user documentation source.
+
+## Development
+
+### Install
+
+```console
+$ sudo apt install libpython-dev
+$ virtualenv venv
+$ source venv/bin/activate
+$ pip install -r requirements.txt
+```
## Environments
diff --git a/mkdocs.yml b/mkdocs.yml
index 3811f599d..f7e647927 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -161,7 +161,7 @@ pages:
- Workbench: software/tools/ansys/workbench.md
- Setting License Preferences: software/tools/ansys/licensing.md
- Licensing and Available Versions: software/tools/ansys/setting-license-preferences.md
- - EasyBuild:
+ - EasyBuild:
- Introduction: software/tools/easybuild.md
- Generating Container Recipes and Images: software/tools/easybuild-images.md
- Singularity Container:
@@ -176,7 +176,7 @@ pages:
- PBS Pro Documentation: pbspro.md
- API Documentation: apiv1.md
- Productivity Tools:
- - EasyBuild:
+ - EasyBuild:
- Introduction: EasyBuild-Hands-on-2018/Introduction.md
- Example 1: EasyBuild-Hands-on-2018/firstsoftware.md
- Example 2: EasyBuild-Hands-on-2018/modification.md
@@ -205,7 +205,8 @@ markdown_extensions:
- codehilite
- markdown.extensions.admonition:
- pymdownx.arithmatex:
- - markdown.extensions.toc(permalink=true):
+ - markdown.extensions.toc:
+ permalink: true
slugify: !!python/name:pymdownx.slugs.uslugify
- pymdownx.snippets:
base_path: docs.it4i/snippets
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 000000000..bd6e2f1b0
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,15 @@
+backports-abc==0.5
+Click==7.0
+futures==3.2.0
+Jinja2==2.10
+livereload==2.5.2
+Markdown==3.0.1
+MarkupSafe==1.0
+mkdocs==1.0.4
+pkg-resources==0.0.0
+Pygments==2.2.0
+pymdown-extensions==6.0
+PyYAML==3.13
+singledispatch==3.4.0.3
+six==1.11.0
+tornado==5.1.1
--
GitLab