Merge branch 'development' of https://github.com/cmu-delphi/signal_documentation into change-requests-#25-#28-#30-#31

Author: Mykhailo Istomin

.env.example

@@ -12,6 +12,13 @@ CSRF_TRUSTED_ORIGINS='http://127.0.0.1:8000,http://localhost:8000'
 SECRET_KEY='secret_key'
 DEBUG='True'
 
+# Sentry
+# Modify the Sentry config here. A DSN string is the minimum. Check the
+# application's Sentry init section and the Sentry documentation for the
+# defaults and options that may be set. If you don't want to use Sentry you can
+# leave this as is.
+#SENTRY_DSN=''
+
 # Add the following to your local .env file. They will be used in the CI process
 # and you can largely forget about them, but including them in your .env file
 # will act like a safe default and help suppress warnings.

Pipfile

@@ -9,7 +9,7 @@ django-filter = "*"
 django-extensions = "*"
 pillow = "*"
 pre-commit = "*"
-sentry-sdk = "*"
+'sentry-sdk[django]' = "*"
 python-dotenv = "*"
 django-health-check = "*"
 django-cors-headers = "*"
@@ -27,6 +27,11 @@ django-extensions-models = "*"
 mypy = "*"
 django-stubs = "*"
 tzdata = "*"
+pyparsing = "*"
+pydot = "*"
+django-docs = "*"
+sphinxcontrib-django = "*"
+sphinx-rtd-theme = "*"
 
 [dev-packages]
 flake8 = "*"

Pipfile.lock

@@ -101,6 +101,10 @@ Changes of this sort should be carefully evaluated as they may require interacti
 ## [Django admin](https://docs.djangoproject.com/en/4.1/ref/contrib/admin/) web interface (user should be `is_staff` or `is_superuser`)
 `http://localhost:8000/admin`
 
+## Read the docs (Sphynx)
+`http://localhost:8000/<MAIN_PAGE>/docs/index.html`
+
+
 
 ## Import data from admin interface
 
@@ -133,20 +137,20 @@ To import data from a CSV file must meet the requirements:
 * Colums should be saparateb by `","`
 
 Othervice you will receive Errors during import process:
-![Import errors](./docs/image-3.png)
+![Import errors](./src/docs/source/_static/import_errors.png)
 
 
 1. Import `SourceSubdivision` instances with `SourceSubdivisionResource` - [http://localhost:8000/admin/datasources/sourcesubdivision/import/](http://localhost:8000/admin/datasources/sourcesubdivision/import/)
-![Import `SourceSubdivision` instances](./docs/image.png)
-![Confirm importing `SourceSubdivision` instances](./docs/image-1.png)
+![Import `SourceSubdivision` instances](./src/docs/source/_static/import_source_subdivision.png)
+![Confirm importing `SourceSubdivision` instances](./src/docs/source/_static/import_confirm_source_subdivision.png)
 
 2. Import `Signal` instances with `SignalResource` - [http://localhost:8000/admin/signals/signal/import/](http://localhost:8000/admin/signals/signal/import/)
-![Import `Signal` instances](./docs/image-2.png)
-![Confirm importing `Signal` instances](./docs/image-4.png)
+![Import `Signal` instances](./src/docs/source/_static/import_signals.png)
+![Confirm importing `Signal` instances](./src/docs/source/_static/import_confirm_signals.png)
 
 3. Import `Signal.base` fields with `SignalBaseResource` - [http://localhost:8000/admin/signals/signal/import/](http://localhost:8000/admin/signals/signal/import/)
-![Import `Signal.base` field](./docs/image-5.png)
-![Confirm importing `Signal.base` fields](./docs/image-6.png)
+![Import `Signal.base` field](./src/docs/source/_static/import_signals_base.png)
+![Confirm importing `Signal.base` fields](./src/docs/source/_static/import_confirm_signals_base.png)
 
 ## Deployment
 

README.md

@@ -0,0 +1 @@
+.git

git

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)