diff --git a/README.rst b/README.rst index 07eac7fd1..9ab15cba2 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,5 @@ -Template for the Read the Docs tutorial +'Read The Docs' Documentation for Group Course Management System (GCMS) ======================================= -This GitHub template includes fictional Python library -with some basic Sphinx docs. - -Read the tutorial here: - +'Read The Docs' tutorial here: https://docs.readthedocs.io/en/stable/tutorial/ diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst new file mode 100644 index 000000000..3130dbe54 --- /dev/null +++ b/docs/source/architecture.rst @@ -0,0 +1,10 @@ +.. _arch-sec: +Architecture +============ +1 page, diagrams optional: + +frontend vs backend + +“layered event-driven architecture with centralized event bus” (from your README) + +key external APIs (Microsoft Graph, OpenAI) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6e9e8c087..f21c7a6e6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,34 +2,34 @@ # -- Project information -project = 'Lumache' -copyright = '2021, Graziella' -author = 'Graziella' +project = "Group Coursework Management System (GCMS)" +copyright = "2026, Group 5B" +author = "Group 5B" -release = '0.1' -version = '0.1.0' +release = "0.1" +version = "0.1.0" # -- General configuration extensions = [ - 'sphinx.ext.duration', - 'sphinx.ext.doctest', - 'sphinx.ext.autodoc', - 'sphinx.ext.autosummary', - 'sphinx.ext.intersphinx', + "sphinx.ext.duration", + "sphinx.ext.doctest", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", ] intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), - 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), } -intersphinx_disabled_domains = ['std'] +intersphinx_disabled_domains = ["std"] -templates_path = ['_templates'] +templates_path = ["_templates"] # -- Options for HTML output -html_theme = 'sphinx_rtd_theme' +html_theme = "sphinx_rtd_theme" # -- Options for EPUB output -epub_show_urls = 'footnote' +epub_show_urls = "footnote" diff --git a/docs/source/index.rst b/docs/source/index.rst index 03d09a55d..307b2bb47 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,22 +1,60 @@ -Welcome to Lumache's documentation! -=================================== +Group Coursework Management System (GCMS) Documentation +======================================================== -**Lumache** (/lu'make/) is a Python library for cooks and food lovers -that creates recipes mixing random ingredients. -It pulls data from the `Open Food Facts database `_ -and offers a *simple* and *intuitive* API. - -Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. +**GCMS** is a web application to help students manage their group coursework projects. .. note:: - This project is under active development. -Contents --------- +.. toctree:: + :maxdepth: 2 + :caption: Table of Contents + + getting-started/index + architecture/index + database-schema/index + api-reference/index + external-integrations/index + troubleshooting + contributing + architecture/folder-structure + architecture/event-bus + +Database Schema +-------------------------------------- .. toctree:: + :maxdepth: 1 + :hidden: + + database-schema/entity-reference + database-schema/er-diagram + +API Reference +---------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + api-reference/auth-routes + api-reference/project-routes + api-reference/task-routes + api-reference/other-routes + +External Integrations +--------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + external-integrations/microsoft-graph + external-integrations/openai + external-integrations/emailjs + +Troubleshooting +------------------------------- - usage - api +Contributing +-------------------------- diff --git a/docs/source/installation.rst b/docs/source/installation.rst new file mode 100644 index 000000000..403af9a9b --- /dev/null +++ b/docs/source/installation.rst @@ -0,0 +1,9 @@ +Pull directly from your main repo reality: + +prerequisites (Node version, npm) + +how to run (npm install, npm start / whatever you use) + +environment variables (.env example) + +database setup (you have a db/ folder) \ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 924afcf6c..20cd06ddf 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -31,4 +31,19 @@ For example: >>> import lumache >>> lumache.get_random_ingredients() ['shells', 'gorgonzola', 'parsley'] +----------------------------------------------------- +Document the core features from your README: +Microsoft sign-in / OneDrive integration + +tasks + weighting + +calendar + +chat + +project board + +notifications + +contribution tracking \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 14a2dda5d..f6a2e24b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,6 @@ requires = ["flit_core >=3.2,<4"] build-backend = "flit_core.buildapi" [project] -name = "lumache" -authors = [{name = "Graziella", email = "graziella@lumache"}] +name = "gcms" +authors = [{name = "Group 5B", email = ""}] dynamic = ["version", "description"]