Deployed c8f1eb5 with MkDocs version: 1.5.3

404.html

@@ -11,7 +11,7 @@
 
 
       <link rel="icon" href="/hanfor/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.1.21">
 
 
 

_build/html/_sources/chapters/contribute/to_docs.md.txt

@@ -1,39 +1,39 @@
-# Documentation
-In this section we explain how you can contribute to the documentation.
-
-## Structure of the Documentation
-Hanfors documentation section is located in the directory `documentation/docs` and looks as follows:
-```
-|-docs
- |- chapters/  # The chapters directory contains the different sections of our documentation.
- |- img/       # In this directory we store images.
- |- conf.py    # The sphinx configuration file.
- |- index.rst  # The index file, it defines the outline of the documentation.
-```
-
-### Chapters
-- Every chapter is a directory in `documentation/docs/chapters`.
-- If you want to **add a new chapter**, you must **create a new directory** and also add it to `index.rst`
-- Inside a chapter-directory you create `.md` or `.rst` files.
-## Contribute
-
-Head over to [Hanfor's Git repository](https://github.com/ultimate-pa/hanfor) and fork it, 
-create to edit existing chapters and when you are done, simply PR.
-
-
-## Sphinx and Sphinx Autobuild
-
-This documentation is made with [sphinx](https://www.sphinx-doc.org/en/master/).
-```
-python3 -m pip install sphinx sphinx-autobuild recommonmark sphinx_rtd_theme dhubbard-sphinx-markdown-tables
-```
-You can now use ``make html`` or ``./make.bat html`` to build your documentation. 
-
-You can also live preview your changes in the browser.
-We just use [autobuild](https://pypi.org/project/sphinx-autobuild/) to automagically build the docs and show them in a web-browser.
-To build a classical Sphinx documentation set, issue the following command in the directory  `documentation`:
-```
-sphinx-autobuild -E docs docs/_build/html
-```
-This will create a directory  `_build` which contains generated HTML files.
+# Documentation
+In this section we explain how you can contribute to the documentation.
+
+## Structure of the Documentation
+Hanfors documentation section is located in the directory `documentation/docs` and looks as follows:
+```
+|-docs
+ |- chapters/  # The chapters directory contains the different sections of our documentation.
+ |- img/       # In this directory we store images.
+ |- conf.py    # The sphinx configuration file.
+ |- index.rst  # The index file, it defines the outline of the documentation.
+```
+
+### Chapters
+- Every chapter is a directory in `documentation/docs/chapters`.
+- If you want to **add a new chapter**, you must **create a new directory** and also add it to `index.rst`
+- Inside a chapter-directory you create `.md` or `.rst` files.
+## Contribute
+
+Head over to [Hanfor's Git repository](https://github.com/ultimate-pa/hanfor) and fork it, 
+create to edit existing chapters and when you are done, simply PR.
+
+
+## Sphinx and Sphinx Autobuild
+
+This documentation is made with [sphinx](https://www.sphinx-doc.org/en/master/).
+```
+python3 -m pip install sphinx sphinx-autobuild recommonmark sphinx_rtd_theme dhubbard-sphinx-markdown-tables
+```
+You can now use ``make html`` or ``./make.bat html`` to build your documentation. 
+
+You can also live preview your changes in the browser.
+We just use [autobuild](https://pypi.org/project/sphinx-autobuild/) to automagically build the docs and show them in a web-browser.
+To build a classical Sphinx documentation set, issue the following command in the directory  `documentation`:
+```
+sphinx-autobuild -E docs docs/_build/html
+```
+This will create a directory  `_build` which contains generated HTML files.
 Then head to `http://127.0.0.1:8000/` and witness the most beautiful documentation ever created.

_build/html/_sources/chapters/contribute/to_hanfor.md.txt

@@ -1,5 +1,5 @@
-# Hanfor
-
-You know the drill, 
-head over to [Hanfor's Git repository](https://github.com/ultimate-pa/hanfor) and fork it, then work in your changes and PR.
-
+# Hanfor
+
+You know the drill, 
+head over to [Hanfor's Git repository](https://github.com/ultimate-pa/hanfor) and fork it, then work in your changes and PR.
+

_build/html/_sources/chapters/installation/configuration.md.txt

@@ -1,64 +1,64 @@
-# Configuration
-
-## Hanfor 
-* Copy `./hanfor/config.dist.py` to `./hanfor/config.py`.
-* Edit the file `/hanfor/config.py` according your needs.
-
-### Hanfor config file:
-A config file looks as follows: 
-```python
-################################################################################
-#                               Storage and folders                            #
-################################################################################
-# Set the SESSION_BASE_FOLDER to a path hanfor will store/load sessions.
-# If set to None, hanfor will store its sessions in ./data
-SESSION_BASE_FOLDER = './data'
-
-################################################################################
-#                                DEBUG and logging                             #
-################################################################################
-
-# Set DEBUG_MODE to true if you want to run the flask app in debug mode.
-# In Production this should be set to False.
-DEBUG_MODE = False
-
-# If ASSETS_DEBUG True, Bundles will output their individual source files.
-# This will significantly slow down performance.
-ASSETS_DEBUG = False
-
-# Set this to false if you want to use DEBUG toolbar with a URL_PREFIX
-DEBUG_TB_INTERCEPT_REDIRECTS = False
-
-# Set the log level to increase or decrease the logging sensitivity.
-# You can set LOG_LEVEL (in decreasing sensitivity to):
-# 'DEBUG', 'INFO', 'WARNING', 'ERROR'
-LOG_LEVEL = 'DEBUG'
-
-# Set LOG_TO_FILE to True if vou want to log to the file
-# you specified in LOG_FILE
-LOG_TO_FILE = True
-LOG_FILE = 'hanfor.log'
-
-# Set PYCHARM_DEBUG to True to supresss the flask debugging so it
-# won't interfere with the pycharm debugger.
-PYCHARM_DEBUG = False
-
-################################################################################
-#                         App and web server section                           #
-################################################################################
-
-# If you are running the app with a url prefix set URL_PREFIX like
-# URL_PREFIX = '/hanfor'
-URL_PREFIX = ''
-
-# set a 'SECRET_KEY' to enable the Flask session cookies
-SECRET_KEY = 'somesecretkeythatisonlyknowntoyou'
-
-# Specify the PORT the app should be running at
-PORT = 5000
-
-# Set the host
-HOST = '127.0.0.1'
-```
-
-## ReqAnalyzer
+# Configuration
+
+## Hanfor 
+* Copy `./hanfor/config.dist.py` to `./hanfor/config.py`.
+* Edit the file `/hanfor/config.py` according your needs.
+
+### Hanfor config file:
+A config file looks as follows: 
+```python
+################################################################################
+#                               Storage and folders                            #
+################################################################################
+# Set the SESSION_BASE_FOLDER to a path hanfor will store/load sessions.
+# If set to None, hanfor will store its sessions in ./data
+SESSION_BASE_FOLDER = './data'
+
+################################################################################
+#                                DEBUG and logging                             #
+################################################################################
+
+# Set DEBUG_MODE to true if you want to run the flask app in debug mode.
+# In Production this should be set to False.
+DEBUG_MODE = False
+
+# If ASSETS_DEBUG True, Bundles will output their individual source files.
+# This will significantly slow down performance.
+ASSETS_DEBUG = False
+
+# Set this to false if you want to use DEBUG toolbar with a URL_PREFIX
+DEBUG_TB_INTERCEPT_REDIRECTS = False
+
+# Set the log level to increase or decrease the logging sensitivity.
+# You can set LOG_LEVEL (in decreasing sensitivity to):
+# 'DEBUG', 'INFO', 'WARNING', 'ERROR'
+LOG_LEVEL = 'DEBUG'
+
+# Set LOG_TO_FILE to True if vou want to log to the file
+# you specified in LOG_FILE
+LOG_TO_FILE = True
+LOG_FILE = 'hanfor.log'
+
+# Set PYCHARM_DEBUG to True to supresss the flask debugging so it
+# won't interfere with the pycharm debugger.
+PYCHARM_DEBUG = False
+
+################################################################################
+#                         App and web server section                           #
+################################################################################
+
+# If you are running the app with a url prefix set URL_PREFIX like
+# URL_PREFIX = '/hanfor'
+URL_PREFIX = ''
+
+# set a 'SECRET_KEY' to enable the Flask session cookies
+SECRET_KEY = 'somesecretkeythatisonlyknowntoyou'
+
+# Specify the PORT the app should be running at
+PORT = 5000
+
+# Set the host
+HOST = '127.0.0.1'
+```
+
+## ReqAnalyzer

_build/html/_sources/chapters/installation/deployment.md.txt

@@ -1,32 +1,32 @@
-# Deployment
-To start a fresh session use
-```bash
-$ python app.py <tag> -c <path_to_input_csv>.csv
-```
-
-Point your browser to [`http://127.0.0.1:<port in config.py>`](http://127.0.0.1:5000)
-
-If you want to start an existing session, use
-```bash
-$ python app.py <tag>
-```
-
-You can see all available tags using the ''-L'' switch:
-```bash
-$ python app.py -L
-```
-
-## How it works
-The app will create a *session* naming it by the given `<tag>` argument.
-A session creation process has the following steps:
-
- 1. Create a session in a folder `config.py_SESSION_BASE_FOLDER/<tag>`.
- 2. Read the given .csv file containing one requirement each row.
- 3. Ask the user about a mapping of the csv-header-names for:
-    * "ID", 
-    * "Description", 
-    * "Formalized Requirement", 
-    * "Type"
- 4. Create a Hanfor-Requirement for each row in the csv and store it to the session folder.
- 5. Provide the Web-interface on the port specified in config.py
-
+# Deployment
+To start a fresh session use
+```bash
+$ python app.py <tag> -c <path_to_input_csv>.csv
+```
+    
+Point your browser to [`http://127.0.0.1:<port in config.py>`](http://127.0.0.1:5000)
+
+If you want to start an existing session, use
+```bash
+$ python app.py <tag>
+```
+
+You can see all available tags using the ''-L'' switch:
+```bash
+$ python app.py -L
+```
+
+## How it works
+The app will create a *session* naming it by the given `<tag>` argument.
+A session creation process has the following steps:
+
+ 1. Create a session in a folder `config.py_SESSION_BASE_FOLDER/<tag>`.
+ 2. Read the given .csv file containing one requirement each row.
+ 3. Ask the user about a mapping of the csv-header-names for:
+    * "ID", 
+    * "Description", 
+    * "Formalized Requirement", 
+    * "Type"
+ 4. Create a Hanfor-Requirement for each row in the csv and store it to the session folder.
+ 5. Provide the Web-interface on the port specified in config.py
+

_build/html/_sources/chapters/installation/preliminaries.md.txt

@@ -1,31 +1,31 @@
-# Preliminaries
-## Install Hanfor 
-Clone the repository:
-```bash
-$ git clone https://github.com/ultimate-pa/hanfor.git -b master --single-branch /your/hanfor/destination 
-```
-
-Hanfor requires [Python](https://www.python.org/) and is only tested with Python 3.6.x.
-You can check if you have python already installed from the command line:
-```bash
-$ python -- version
-Python 3.6.2
-```
-
-We recommend using a [virtual environment](https://virtualenv.pypa.io/en/latest/installation/). Create a new virtual environment with: 
-```bash
-$ virtualenv hanfor_python 
-```
-And activate it by sourcing:
-```bash
-$ source hanfor_python/bin/activate
-```
-
-Now the python dependencies needed to be installed into the virtual environment.
-Inside the repository run:
-```bash
-$ pip install -r requirements.txt
-```
-
-## Install ReqAnalyzer
+# Preliminaries
+## Install Hanfor 
+Clone the repository:
+```bash
+$ git clone https://github.com/ultimate-pa/hanfor.git -b master --single-branch /your/hanfor/destination 
+```
+
+Hanfor requires [Python](https://www.python.org/) and is only tested with Python 3.6.x.
+You can check if you have python already installed from the command line:
+```bash
+$ python -- version
+Python 3.6.2
+```
+
+We recommend using a [virtual environment](https://virtualenv.pypa.io/en/latest/installation/). Create a new virtual environment with: 
+```bash
+$ virtualenv hanfor_python 
+```
+And activate it by sourcing:
+```bash
+$ source hanfor_python/bin/activate
+```
+
+Now the python dependencies needed to be installed into the virtual environment.
+Inside the repository run:
+```bash
+$ pip install -r requirements.txt
+```
+
+## Install ReqAnalyzer
 *Comming soon*