From d5b48c1603ac64c2a00f32252e71e37b18e6596c Mon Sep 17 00:00:00 2001
From: Neda Moeini <neda.moeini@geant.org>
Date: Mon, 7 Oct 2024 10:49:34 +0200
Subject: [PATCH] Add Sphinx docs.
---
LICENSE | 3 +++
MANIFEST.in | 4 +++
docs/Makefile | 20 +++++++++++++++
docs/make.bat | 35 ++++++++++++++++++++++++++
docs/source/conf.py | 55 +++++++++++++++++++++++++++++++++++++++++
docs/source/index.rst | 20 +++++++++++++++
file_validator/views.py | 2 +-
requirements.txt | 4 ++-
setup.py | 17 +++++++++++++
9 files changed, 158 insertions(+), 2 deletions(-)
create mode 100644 LICENSE
create mode 100644 MANIFEST.in
create mode 100644 docs/Makefile
create mode 100644 docs/make.bat
create mode 100644 docs/source/conf.py
create mode 100644 docs/source/index.rst
create mode 100644 setup.py
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ff62c81
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,3 @@
+MIT License
+
+Copyright (c) 2023-2024 GÉANT Software Development Team
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..c475ff5
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,4 @@
+recursive-include file_validator/templates *
+recursive-include theme/static *
+recursive-include theme/templates *
+include manage.py
\ No newline at end of file
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/docs/Makefile
@@ -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)
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..747ffb7
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..67a5149
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../sage-validation'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Sage Validation'
+copyright = '2024, GÉANT'
+author = 'GÉANT'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..2af1b6c
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,20 @@
+.. Sage Validation documentation master file, created by
+ sphinx-quickstart on Mon Oct 7 09:58:36 2024.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Sage Validation's documentation!
+===========================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/file_validator/views.py b/file_validator/views.py
index bd988b1..23ccaee 100644
--- a/file_validator/views.py
+++ b/file_validator/views.py
@@ -6,7 +6,7 @@ from .forms import CSVUploadForm
class CSVUploadView(FormView):
- template_name = 'templates/upload.html'
+ template_name = 'upload.html'
form_class = CSVUploadForm
success_url = reverse_lazy('upload-file')
diff --git a/requirements.txt b/requirements.txt
index 506edb2..076ef1b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,4 +2,6 @@ Django==5.1.1
django-tailwind
ruff
mypy
-tox
\ No newline at end of file
+tox
+sphinx
+sphinx-autodoc-typehints
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..0154142
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,17 @@
+from setuptools import setup, find_packages
+
+setup(
+ name='sage-validation',
+ version='0.1',
+ packages=find_packages(),
+ include_package_data=True,
+ install_requires=[
+ 'Django==5.1.1'
+ ],
+ classifiers=[
+ 'Programming Language :: Python :: 3',
+ 'Framework :: Django',
+ 'Operating System :: OS Independent',
+ ],
+ python_requires='>=3.12'
+)
--
GitLab