diff --git a/.gitignore b/.gitignore index 0682751bb669c6d17d9b86afc76457ada1cf145c..fd2940e4fcee8f17b63dc19a4a946bb656897a31 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ site/ scripts/*.csv +venv/ diff --git a/README.md b/README.md index 82d31ceb8fc065ec8a7985310214a192a936b7e6..686439b27bd3bedf525a9e83ac7f6f04672bc98f 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 3811f599d7d1c8715c9fd285cfaed51a62374f2c..f7e647927d86a3e402c393b27cca7b0fecfcaf30 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 0000000000000000000000000000000000000000..bd6e2f1b00747a79f4400135a3c9e08831d71619 --- /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