diff --git a/compose.yaml b/compose.yaml index 7a24ca9..428444e 100644 --- a/compose.yaml +++ b/compose.yaml @@ -8,9 +8,6 @@ services: - 50051:50051 material-server-db: image: mongo - restart: always - volumes: - - material-server-mongodb:/data/db mongoexpress: image: mongo-express ports: @@ -19,5 +16,3 @@ services: - material-server-db environment: - ME_CONFIG_MONGODB_URL=mongodb://db:27017 -volumes: - material-server-mongodb: diff --git a/docs/conf.py b/docs/conf.py index 21a5c1b..116efd1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,47 @@ -# import os -# import sys -# import sphinx_rtd_theme +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -# sys.path.insert(0, os.path.abspath('..')) +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme"] +import os +import sys +import sphinx_rtd_theme + +# This is to prevent mypy from declaring sphinx_rtd_theme as a missing import. +sphinx_rtd_theme + +sys.path.insert(0, os.path.abspath("..")) + +project = "evalquiz-material-server" +copyright = "2023, Author" +author = "Author" + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "sphinx.ext.todo", + "sphinx.ext.napoleon", + "sphinx_rtd_theme", +] + +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +language = "en" + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] + +# -- Options for todo extension ---------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration + +todo_include_todos = True diff --git a/docs/evalquiz_proto.rst b/docs/evalquiz_proto.rst new file mode 100644 index 0000000..dddf1b7 --- /dev/null +++ b/docs/evalquiz_proto.rst @@ -0,0 +1,19 @@ +evalquiz\_proto package +======================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + evalquiz_proto.shared + evalquiz_proto.tests + +Module contents +--------------- + +.. automodule:: evalquiz_proto + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/evalquiz_proto.shared.generated.rst b/docs/evalquiz_proto.shared.generated.rst new file mode 100644 index 0000000..f4eb746 --- /dev/null +++ b/docs/evalquiz_proto.shared.generated.rst @@ -0,0 +1,10 @@ +evalquiz\_proto.shared.generated package +======================================== + +Module contents +--------------- + +.. automodule:: evalquiz_proto.shared.generated + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/evalquiz_proto.shared.rst b/docs/evalquiz_proto.shared.rst new file mode 100644 index 0000000..66d9656 --- /dev/null +++ b/docs/evalquiz_proto.shared.rst @@ -0,0 +1,53 @@ +evalquiz\_proto.shared package +============================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + evalquiz_proto.shared.generated + +Submodules +---------- + +evalquiz\_proto.shared.exceptions module +---------------------------------------- + +.. automodule:: evalquiz_proto.shared.exceptions + :members: + :undoc-members: + :show-inheritance: + +evalquiz\_proto.shared.internal\_lecture\_material module +--------------------------------------------------------- + +.. automodule:: evalquiz_proto.shared.internal_lecture_material + :members: + :undoc-members: + :show-inheritance: + +evalquiz\_proto.shared.mimetype\_resolver module +------------------------------------------------ + +.. automodule:: evalquiz_proto.shared.mimetype_resolver + :members: + :undoc-members: + :show-inheritance: + +evalquiz\_proto.shared.path\_dictionary\_controller module +---------------------------------------------------------- + +.. automodule:: evalquiz_proto.shared.path_dictionary_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: evalquiz_proto.shared + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/evalquiz_proto.tests.rst b/docs/evalquiz_proto.tests.rst new file mode 100644 index 0000000..46bcb2b --- /dev/null +++ b/docs/evalquiz_proto.tests.rst @@ -0,0 +1,18 @@ +evalquiz\_proto.tests package +============================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + evalquiz_proto.tests.shared + +Module contents +--------------- + +.. automodule:: evalquiz_proto.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/evalquiz_proto.tests.shared.rst b/docs/evalquiz_proto.tests.shared.rst new file mode 100644 index 0000000..7015de1 --- /dev/null +++ b/docs/evalquiz_proto.tests.shared.rst @@ -0,0 +1,21 @@ +evalquiz\_proto.tests.shared package +==================================== + +Submodules +---------- + +evalquiz\_proto.tests.shared.test\_internal\_lecture\_material module +--------------------------------------------------------------------- + +.. automodule:: evalquiz_proto.tests.shared.test_internal_lecture_material + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: evalquiz_proto.tests.shared + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 3b527ae..5c130a5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,22 @@ -Welcome to the Evalquiz documentation! -====================================== +.. evalquiz-material-server documentation master file, created by + sphinx-quickstart on Thu Sep 21 09:12:24 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to evalquiz-material-server's documentation! +==================================================== .. toctree:: - :maxdepth: 2 + :maxdepth: 4 + :caption: Contents: + + evalquiz_material_server + evalquiz_proto + + +Indices and tables +================== - modules \ No newline at end of file +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index 9a5d23f..0000000 --- a/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -evalquiz_material_server -======================== - -.. toctree:: - :maxdepth: 4 - - evalquiz_material_server diff --git a/mypy.ini b/mypy.ini index 8d76561..c80cc29 100644 --- a/mypy.ini +++ b/mypy.ini @@ -40,6 +40,9 @@ ignore_missing_imports = True [mypy-pkg_resources] ignore_missing_imports = True +[mypy-setuptools] +ignore_missing_imports = True + # Ignore type errors that are made by betterproto-python [mypy-evalquiz_proto.shared.generated.*] ignore_errors = True diff --git a/requirements.txt b/requirements.txt index a71f970..0f1229c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -14,4 +14,5 @@ jsonpickle schedule sphinx sphinx_rtd_theme -pymongo \ No newline at end of file +pymongo +setuptools \ No newline at end of file diff --git a/setup.py b/setup.py index 5cf8af2..0874f40 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,6 @@ import pathlib import pkg_resources +from setuptools import setup with pathlib.Path("requirements.txt").open() as requirements_txt: install_requires = [ @@ -7,12 +8,10 @@ for requirement in pkg_resources.parse_requirements(requirements_txt) ] -from distutils.core import setup - setup( - name="Evalquiz Material Server", + name="evalquiz_material_server", version="1.0", author_email="st170001@stud.uni-stuttgart.de", - packages=["evalquiz_pipeline_server"], + packages=["evalquiz_material_server"], install_requires=install_requires, )