Skip to content
Merged
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
20 changes: 15 additions & 5 deletions docs/make_docs.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
#!/bin/zsh -f
#!/bin/bash -f

source ../venv/bin/activate
PROJECTDIR=${0:a:h}/..
export PYTHONPATH="$PROJECTDIR/src:$PROJECTDIR/tests"
echo "Python path is set to: $PYTHONPATH"
DOCS_FOLDER="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
PROJECT_ROOT="$DOCS_FOLDER/.."
export PYTHONPATH="$PROJECT_ROOT/src"

echo "Documents Folder : $DOCS_FOLDER"
echo "Project Root : $PROJECT_ROOT"
echo "Python Path : $PYTHONPATH"

# The assumption is there is already a virtual environment with the requirements to
# run the analyser installed. This simply activates it and adds in the Sphinx requirements
. "$PROJECT_ROOT/venv/bin/activate"
pip install -r requirements.txt

# Build the documentation
make html
deactivate
9 changes: 9 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
alabaster==0.7.12
Sphinx
sphinx-rtd-theme
sphinxcontrib-applehelp
sphinxcontrib-devhelp
sphinxcontrib-htmlhelp
sphinxcontrib-jsmath
sphinxcontrib-qthelp
sphinxcontrib-serializinghtml
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Nature Recorder

naturerec_model/index
naturerec_web/index
locust_tests/index


Indices and tables
Expand Down
8 changes: 0 additions & 8 deletions docs/source/locust_tests/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/source/locust_tests/locustfile.rst

This file was deleted.

23 changes: 0 additions & 23 deletions features/categories.feature

This file was deleted.

35 changes: 0 additions & 35 deletions features/conservation_status.feature

This file was deleted.

127 changes: 0 additions & 127 deletions features/environment.py

This file was deleted.

32 changes: 0 additions & 32 deletions features/export.feature

This file was deleted.

58 changes: 0 additions & 58 deletions features/flask_app_runner.py

This file was deleted.

6 changes: 0 additions & 6 deletions features/jobs.feature

This file was deleted.

40 changes: 0 additions & 40 deletions features/life_list.feature

This file was deleted.

Loading