diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4932e11996e..92746791a5e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -118,9 +118,17 @@ "if": "github.event_name == 'push' && (github.repository_owner != 'tjcsl' || github.ref != 'refs/heads/master' || github.ref != 'refs/heads/dev')", "run": "git fetch origin ${{ github.event.before }} && ./scripts/validate-commit-messages.py ${{ github.event.before }}..${{ github.event.after }}" }, + { + "name": "Install docs dependencies", + "run": "# sphinxcontrib_django imports our django project, so we need the deps\npip install -U -r requirements.txt\ncd docs\npip install -U -r requirements.txt\n" + }, + { + "name": "Check docs build up to date", + "run": "./scripts/build_ensure_no_changes.sh python3 build_docs.py" + }, { "name": "Build docs", - "run": "./scripts/build_ensure_no_changes.sh ./scripts/build_docs.sh" + "run": "cd docs\nmake html\n" }, { "name": "Push docs", diff --git a/.gitignore b/.gitignore index 18e47145c08..2192df5edab 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ Pipfile build .coverage dist/*.tar.gz +docs/source/reference # General ignores *.crt diff --git a/README.rst b/README.rst index f868b6130e1..e7cc24ccc58 100644 --- a/README.rst +++ b/README.rst @@ -20,10 +20,10 @@ Documentation (in RestructuredText format) is available inside the "docs" folder **Ion now requires Python 3.8+** Python 3.8.5 is currently used in both production and testing environments. -**How can I create a testing environment?** Read the section on `Setting up a Dev Environment `_ in the documentation. +**How can I create a testing environment?** Read the section on `Setting up a Dev Environment `_ in the documentation. **How can I contribute to Ion? How can I report a bug? How can I report a security issue/vulnerability?** -Please read our `contributing guide `_ for more information. +Please read our `contributing guide `_ for more information. Current Intranet maintainers: `alanzhu0 `_ and `NotFish232 `_ diff --git a/ci/spec.yml b/ci/spec.yml index ee902f34ea7..7baca43f38e 100644 --- a/ci/spec.yml +++ b/ci/spec.yml @@ -119,8 +119,21 @@ jobs: run: 'git fetch origin ${{ github.event.before }} && ./scripts/validate-commit-messages.py ${{ github.event.before }}..${{ github.event.after }}' # Build/push docs + - name: Install docs dependencies + run: | + # sphinxcontrib_django imports our django project, so we need the deps + pip install -U -r requirements.txt + cd docs + pip install -U -r requirements.txt + + - name: Check docs build up to date + run: ./scripts/build_ensure_no_changes.sh python3 build_docs.py + - name: Build docs - run: ./scripts/build_ensure_no_changes.sh ./scripts/build_docs.sh + run: | + cd docs + make html + - name: Push docs # Only run for pushes to the main Ion repo if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository_owner == 'tjcsl' && matrix.python-version == 3.8 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000000..23091170e63 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,24 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= -j auto +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 + +cleanall: clean + @echo "Cleaning all references" + @rm source/reference/* + +# 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/_ext/djangodocs.py b/docs/_ext/djangodocs.py deleted file mode 100644 index 07897109504..00000000000 --- a/docs/_ext/djangodocs.py +++ /dev/null @@ -1,8 +0,0 @@ -# -*- coding: utf-8 -*- -def setup(app): - """Setup for djangodocs.""" - app.add_crossref_type( - directivename="setting", - rolename="setting", - indextemplate="pair: %s; setting", - ) diff --git a/docs/_templates/relations.html b/docs/_templates/relations.html deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/developing/styleguide.rst b/docs/developing/styleguide.rst deleted file mode 100644 index 15abe4fc1f2..00000000000 --- a/docs/developing/styleguide.rst +++ /dev/null @@ -1,107 +0,0 @@ -****************** -Coding Style Guide -****************** - -Follow `PEP8 `_ (the official style guide for Python). Most PEP8 formatting conventions are enforced in the build by ``pylint``, ``flake8``, and a combination of ``black``, ``autopep8``, and ``isort``. Therefore, if you do not follow them, the build may not pass. - -However, for Ion, we limit the lengths of lines to 150 characters, not 80 characters. - -Note: CSS/JS/template formatting is enforced by ``scripts/static_templates_format.sh``. Currently, this just strips trailing whitespace. - -Main points -=========== - -- Indent using 4 spaces. -- Use underscores in favor of camel case for all names except the names of classes. -- Limit the line length of docstrings or comments to 72 characters. -- Separate top-level functions and class definitions with two blank lines. -- Separate method definitions inside a class with a single blank line. -- Use two spaces before inline comments and one space between the pound sign and comment. -- Use a plugin for your text editor to check for/remind you of PEP8 conventions. -- When in doubt, running ``./scripts/format.sh`` will fix a lot of things. -- Capitalize and punctuate comments and Git commit messages properly. - -What is enforced in the build -============================= - -At the time of this writing, the GitHub Actions build runs the following commands: - -.. code-block:: sh - - flake8 --max-line-length 150 --exclude=*/migrations/* . - pylint --jobs=0 --disable=fixme,broad-except,global-statement,attribute-defined-outside-init intranet/ - isort --check --recursive intranet - ./scripts.format.sh - ./scripts/static_templates_format.sh # Static/template files - -Note: When the ``./scripts/format.sh`` and ``./scripts/static_templates_format.sh`` checks are run, the build will fail if they have to make any changes. - -``flake8`` is a PEP8 style checker, ``pylint`` is a linter (but it also enforces some PEP8 conventions), and ``isort``, when called with these options, checks that all imports are sorted alphabetically. - -``./scripts/format.sh`` runs ``black intranet && autopep8 --in-place --recursive intranet && isort --recursive intranet``. The reason for the multiple commands is that ``black`` introduces certain formatting changes which ``flake8``/``pylint`` do not agree with (and offers no options to change them), so we have ``autopep8`` fix it. - -It is recommended that you run all of these locally before opening a pull request (though the Ion developers sometimes skip running the ``pylint`` check locally because it takes a long time to run). All of them are intended to be run from the root directory of the Git repository. - -If ``flake8`` or ``pylint`` throw errors, the error messages are usually human-readable. if ``isort`` gives any errors, you can have it automatically correct the order of all imports by running ``isort --recursive intranet``. If the build fails because running ``scripts/format.sh`` resulted in changes, you can simply run ``./scripts/format.sh`` to fix your formatting. - -Imports -======= - -- Group imports in the following order: - #. Standard library imports - #. Third-party imports - #. Imports from Django - #. Local imports - -- Within these groups, place ``from ... import ...`` imports after ``import ...`` imports, and order imports alphabetically within *those* groups. - -- Avoid using ``from ... import *``. - -- Explicitly import each module used. - -- Use relative imports to avoid hardcoding a module's package name. This greatly improves portability and is useful when importing from another module in the current app. - -Examples --------- - -Standard library imports: - -.. code-block:: python - - from math import sqrt - from os.path import abspath - -Core Django imports: - -.. code-block:: python - - from django.db import models - -Third-party app imports: - -.. code-block:: python - - from django_extensions.db.models import TimeStampedModel - -Good: - -.. code-block:: python - - from .models import SomeModel # explicit relative import - from otherdjangoapp.models import OtherModel # absolute import - -Bad: - -.. code-block:: python - - # intranet/apps/users/views.py - from intranet.apps.users.models import MyModel # absolute import within same package - - -References -========== - -- `Google Python Style Guide `_. -- `Google HTML/CSS Style Guide `_. -- `Google Javascript Style Guide `_. -- `PEP8: Official Python Style Guide `_. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000000..564c2860c28 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +furo +myst-parser +sphinx-copybutton +sphinxcontrib-django diff --git a/docs/rtd-requirements.txt b/docs/rtd-requirements.txt deleted file mode 100644 index 71bbe37d0a4..00000000000 --- a/docs/rtd-requirements.txt +++ /dev/null @@ -1,68 +0,0 @@ -argon2-cffi==21.3.0 -autobahn==22.7.1 -Babel==2.10.3 -bcrypt==4.0.0 -beautifulsoup4==4.11.1 -bleach==5.0.1 -celery==5.2.7 -certifi==2024.07.04 -channels==3.0.5 -channels-redis==3.4.1 -contextlib2==21.6.0 -cryptography==42.0.4 -decorator==5.1.1 -Django==3.2.25 -django-cacheops==7.0.1 -django-cors-headers==3.13.0 -django-debug-toolbar==3.6.0 -django-extensions==3.2.0 -django-formtools==2.3 -django-inline-svg==0.1.1 -django-maintenance-mode==0.16.3 -django-oauth-toolkit==2.3.0 -django-pipeline==2.0.9 -django-prometheus==2.2.0 -django-redis-cache==3.0.1 -django-redis-sessions==0.6.2 -django-referrer-policy==1.0 -django-requestlogging-redux==1.2.1 -django-simple-history==3.1.1 -django-user-agents==0.4.0 -django-widget-tweaks==1.4.12 -djangorestframework==3.14.0 -docutils==0.19 -Fabric3==1.14.post1 -flower==1.2.0 -gunicorn==22.0.0 -hiredis==2.0.0 -ipython==8.10.0 -isort==5.12.0 -lxml==4.9.1 -objgraph==3.5.0 -pexpect==4.8.0 -prometheus-client==0.17.0 -psycopg2==2.9.9 -pycryptodome==3.19.1 -pyrankvote==2.0.5 -pysftp==0.2.9 -python-dateutil==2.8.2 -python-magic==0.4.27 -python-pam==2.0.2 -reportlab==3.6.13 -requests==2.32.0 -requests-oauthlib==1.3.1 -sentry-sdk==1.15.0 -setuptools-git==1.2 -six==1.16.0 -Sphinx==5.2.3 -sphinx-bootstrap-theme==0.8.1 -tblib==1.7.0 -vine==5.0.0 -xhtml2pdf==0.2.11 - -# Not direct dependencies, but need to be bumped for some reason -# (for example, bug or security fixes) -asgiref>=3.3.4 -pillow>=9.0.0 -tinycss2 -twisted>=21.7.0 diff --git a/docs/_static/custom.css b/docs/source/_static/custom.css similarity index 100% rename from docs/_static/custom.css rename to docs/source/_static/custom.css diff --git a/docs/favicon.ico b/docs/source/_static/favicon.ico similarity index 100% rename from docs/favicon.ico rename to docs/source/_static/favicon.ico diff --git a/docs/source/_static/logo-dark.svg b/docs/source/_static/logo-dark.svg new file mode 100644 index 00000000000..42b1477cb1c --- /dev/null +++ b/docs/source/_static/logo-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/source/_static/logo-light.svg b/docs/source/_static/logo-light.svg new file mode 100644 index 00000000000..cfa12c9cc10 --- /dev/null +++ b/docs/source/_static/logo-light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst new file mode 100644 index 00000000000..7ef38d10824 --- /dev/null +++ b/docs/source/_templates/autosummary/class.rst @@ -0,0 +1,34 @@ +{{ name | escape | underline}} + +Qualified name: ``{{ fullname | escape }}`` + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :show-inheritance: + :members: + :private-members: + + + {% block methods %} + {%- if methods %} + .. rubric:: {{ _('Methods') }} + + .. autosummary:: + :nosignatures: + {% for item in methods if item != '__init__' and item[0] != '_' and item not in inherited_members %} + ~{{ name }}.{{ item }} + {%- endfor %} + {%- endif %} + {%- endblock %} + + {% block attributes %} + {%- if attributes %} + .. rubric:: {{ _('Attributes') }} + + .. autosummary:: + {% for item in attributes if item[0] != '_' and item not in inherited_members %} + ~{{ name }}.{{ item }} + {%- endfor %} + {%- endif %} + {% endblock %} diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst new file mode 100644 index 00000000000..8aba97b3ba4 --- /dev/null +++ b/docs/source/_templates/autosummary/module.rst @@ -0,0 +1,52 @@ +{{ name | escape | underline }} + +.. currentmodule:: {{ fullname }} + +.. automodule:: {{ fullname }} + + {% block classes %} + {% if classes %} + .. rubric:: Classes + + .. autosummary:: + :toctree: . + :nosignatures: + {% for class in classes %} + {{ class }} + {% endfor %} + {% endif %} + {% endblock %} + + {% block functions %} + {% if functions %} + .. rubric:: {{ _('Functions') }} + + {% for item in functions %} + .. autofunction:: {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block exceptions %} + {% if exceptions %} + .. rubric:: {{ _('Exceptions') }} + + .. autosummary:: + {% for item in exceptions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + +{% block modules %} +{% if modules %} +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: +{% for item in modules %} + {{ item }} +{%- endfor %} +{% endif %} +{% endblock %} diff --git a/docs/architecture/index.rst b/docs/source/architecture/index.rst similarity index 100% rename from docs/architecture/index.rst rename to docs/source/architecture/index.rst diff --git a/docs/conf.py b/docs/source/conf.py similarity index 58% rename from docs/conf.py rename to docs/source/conf.py index ca745334770..f13d9ab5c9b 100644 --- a/docs/conf.py +++ b/docs/source/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- -# # TJ Intranet documentation build configuration file, created by # sphinx-quickstart on Wed Jan 7 14:37:16 2015. # @@ -15,42 +13,33 @@ import os import sys from datetime import datetime -from unittest import mock - -import sphinx_bootstrap_theme +from pathlib import Path -import django +# -- Add to sys.path ------------------------------------------------------ +ION_ROOT = Path(__file__).parent.parent.parent.resolve() +sys.path.insert(0, os.fspath(ION_ROOT)) -# 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. -# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "djangodocs"] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix of source filenames. -source_suffix = ".rst" - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - # General information about the project. project = "TJ Intranet" -copyright = "{}, TJ Intranet Development Team".format(datetime.now().year) +copyright = f"{datetime.now().year}, TJ Intranet Development Team" + +django_settings = "intranet.settings" + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.extlinks", + "sphinx.ext.napoleon", + "sphinx.ext.viewcode", + "sphinx_copybutton", + "myst_parser", + "sphinxcontrib_django", +] + +autosummary_generate = True # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -62,100 +51,76 @@ release = "v3" if "GITHUB_RUN_NUMBER" in os.environ: - release += " (Build #{})".format(os.environ["GITHUB_RUN_NUMBER"]) + release += f" (Build #{os.environ['GITHUB_RUN_NUMBER']})" -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' +templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True +# We depend on sphinxcontrib_django for intersphinx mappings -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" +extlinks = { + "issue": ("https://github.com/tjcsl/ion/issues/%s", "issue %s"), + "pr": ("https://github.com/tjcsl/ion/pull/%s", "pr #%s"), +} +# warn hardcoded links +extlinks_detect_hardcoded_links = True -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] +source_suffix = [".rst", ".md"] -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False # -- 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 = "bootstrap" +html_theme = "furo" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - # Navigation bar title. (Default: ``project`` value) - # 'navbar_title': "", - # Tab name for entire site. (Default: "Site") - "navbar_site_name": "Topics", - "navbar_pagenav_name": "Section", - # Global TOC depth for "site" navbar tab. (Default: 1) - # Switching to -1 shows all levels. - "globaltoc_depth": 2, - # Include hidden TOCs in Site navbar? - # - # Note: If this is "false", you cannot have mixed ``:hidden:`` and - # non-hidden ``toctree`` directives in the same page, or else the build - # will break. - # - # Values: "true" (default) or "false" - "globaltoc_includehidden": "true", - # HTML navbar class (Default: "navbar") to attach to
element. - # For black navbar, do "navbar navbar-inverse" - "navbar_class": "navbar", - # Fix navigation bar to top of page? - # Values: "true" (default) or "false" - "navbar_fixed_top": "true", - # Location of link to source. - # Options are "nav" (default), "footer" or anything else to exclude. - "source_link_position": "footer", - # Bootswatch (http://bootswatch.com/) theme. - # - # Options are nothing with "" (default) or the name of a valid theme - # such as "amelia" or "cosmo". - # - # Note that this is served off CDN, so won't be available offline. - "bootswatch_theme": "pulse", - "bootstrap_version": "3", + "source_repository": "https://github.com/tjcsl/ion/", + "source_branch": "dev", + "source_directory": "docs/source/", + "light_logo": "logo-light.svg", + "dark_logo": "logo-dark.svg", + "sidebar_hide_name": True, + "light_css_variables": { + "color-content-foreground": "#000000", + "color-background-primary": "#ffffff", + "color-background-border": "#ffffff", + "color-sidebar-background": "#f8f9fb", + "color-brand-content": "#1c00e3", + "color-brand-primary": "#192bd0", + "color-link": "#c93434", + "color-link--hover": "#5b0000", + "color-inline-code-background": "#f6f6f6;", + "color-foreground-secondary": "#000", + }, + "dark_css_variables": { + "color-content-foreground": "#ffffffd9", + "color-background-primary": "#131416", + "color-background-border": "#303335", + "color-sidebar-background": "#1a1c1e", + "color-brand-content": "#2196f3", + "color-brand-primary": "#007fff", + "color-link": "#51ba86", + "color-link--hover": "#9cefc6", + "color-inline-code-background": "#262626", + "color-foreground-secondary": "#ffffffd9", + }, } -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -# html_title = None +html_title = "TJHSST Intranet" # A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None +html_short_title = "Ion" # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -294,11 +259,6 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("https://docs.python.org/3", None), - "django": ("https://docs.djangoproject.com/en/dev", "https://docs.djangoproject.com/en/dev/_objects/"), -} autodoc_inherit_docstrings = False @@ -314,28 +274,6 @@ napoleon_use_param = True napoleon_use_rtype = True -# -- Django Setup ------------------------------------------------------------- - -# add project root -sys.path.append(os.path.dirname(os.path.dirname(__file__))) - -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "intranet.settings") - -# Don't spin up a ldap server when building docs. -sys.modules["ldap_test"] = mock.MagicMock() - -# Django docs -sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))) - -django.setup() - - -def skip(app, what, name, obj, skip, options): - """Methods to skip when generating documentation from docstrings.""" - if name in ("__weakref__", "__dict__", "base_fields", "media", "history_object"): - return True - return skip - - -def setup(app): - app.connect("autodoc-skip-member", skip) +napoleon_custom_sections = [ + ("WIDGETS", "params_style"), +] diff --git a/CONTRIBUTING.md b/docs/source/developing/contributing.md similarity index 78% rename from CONTRIBUTING.md rename to docs/source/developing/contributing.md index c0217802820..cd4d039bf37 100644 --- a/CONTRIBUTING.md +++ b/docs/source/developing/contributing.md @@ -8,13 +8,13 @@ If you are a TJHSST student, you can join the `#ion` channel on the [TJ CSL Slac - Please use the templates. If none of them is a perfect match, choose the closest one. ## Security Vulnerabilities & Responsible Disclosure -Please see [our security policy](SECURITY.md). Do not report security vulnerabilities in the public issue tracker. +Please see [our security policy](#security-policy). Do not report security vulnerabilities in the public issue tracker. ## Pull Requests - All PRs should target `dev`, not `master`. - If the change is anything more than a simple typo or a fairly obvious fix, please [set up a development environment](docs/setup/vagrant.rst) and test the change there before submitting a PR. -- It is strongly recommended that you [run `flake8`, `pylint`, `isort`, `scripts/format.sh`](docs/developing/styleguide.rst#what-is-enforced-in-the-build), and [the test suite](docs/developing/testing.rst#running-tests) to ensure that the build will pass. Please also read the entire [style guide](docs/developing/styleguide.rst). -- Please read [Formatting commit messages](docs/developing/howto.rst#formatting-commit-messages). +- It is strongly recommended that you [run `pre-commit`](#pre_commit), and [the test suite](#running-tests) to ensure that the build will pass. Please also read the entire [style guide](styleguide.rst). +- Please read [Formatting commit messages](#formatting_commits). - If your PR closes an issue, include "Closes #XXX" or similar in the messages of the commits that close each issue so the issues will be [automatically closed](https://help.github.com/en/articles/closing-issues-using-keywords) when the commits are merged into `master`. Note that including this text in your PR's description will have no effect because the PR will be merged into `dev`, not `master`, so GitHub does not close the issue. You must add the auto-closing keywords to the *commit* messages. - Keep each commit/PR minimal. diff --git a/docs/developing/eighth-models.rst b/docs/source/developing/eighth-models.rst similarity index 100% rename from docs/developing/eighth-models.rst rename to docs/source/developing/eighth-models.rst diff --git a/docs/developing/howto.rst b/docs/source/developing/howto.rst similarity index 75% rename from docs/developing/howto.rst rename to docs/source/developing/howto.rst index 9220a86ef04..e13a5c54669 100644 --- a/docs/developing/howto.rst +++ b/docs/source/developing/howto.rst @@ -5,31 +5,40 @@ How to do Ion development Formatting your code ==================== -You can run ``./scripts/format.sh`` to automatically format your Python code to adhere to PEP8 standards. +You can run ``pre-commit run --all-files`` to automatically format your Python code to adhere to PEP8 standards. Updating the dev branch ======================= -- git fetch --all -- git checkout dev -- git pull origin dev (note that if dev has been rebased, this may cause a conflict) +- ``git fetch --all`` +- ``git checkout dev`` +- ``git pull origin dev`` (note that if dev has been rebased, this may cause a conflict) - if dev has been rebased, make *absolutely* sure that you don't have any local changes - and run git reset --hard origin/dev this *will* destroy any local changes you have made to dev. -- git push + and run ``git reset --hard origin/dev`` + + .. danger:: + + This *will* destroy any local changes you have made to ``dev``. + +- ``git push`` Fixing build ============ -You can run ``./deploy`` to fix or find most of your build problems. If you add a new file, you may need to run ``./setup.py egg_info``. +You can run ``./deploy`` to fix or find most of your build problems. Viewing documentation locally ============================= -You can view the documentation locally by running the commands below in the virtual machine. +You can view the documentation locally by running:: + + make html + +and then opening the file ``build/html/index.html`` in your browser. + -- ./scripts/build_docs.sh -- cd build/sphinx/html -- python -m http.server 8080 + +.. _formatting_commits: Formatting commit messages ========================== @@ -37,7 +46,9 @@ Formatting commit messages Effective June 2019, the Ion team uses the `Conventional Commit specification `_ to format commit messages. This means that all commit messages should be structured as follows + .. code-block:: text + [optional scope]: [optional body] @@ -58,7 +69,9 @@ The types that we use are: - ``test``: Adding missing tests or correcting existing tests For example, if a commit adds a new feature to the ``emailfwd`` app, a good commit message would be: + .. code-block:: text + feat(emailfwd): add email confirmation functionality Fixes #1 diff --git a/docs/developing/index.rst b/docs/source/developing/index.rst similarity index 85% rename from docs/developing/index.rst rename to docs/source/developing/index.rst index deedcd3e2a6..9935e3ddc09 100644 --- a/docs/developing/index.rst +++ b/docs/source/developing/index.rst @@ -3,6 +3,7 @@ Developing for Intranet *********************** .. toctree:: + :maxdepth: 2 :glob: * diff --git a/docs/developing/oauth.rst b/docs/source/developing/oauth.rst similarity index 100% rename from docs/developing/oauth.rst rename to docs/source/developing/oauth.rst diff --git a/docs/developing/requirements.rst b/docs/source/developing/requirements.rst similarity index 100% rename from docs/developing/requirements.rst rename to docs/source/developing/requirements.rst diff --git a/docs/source/developing/styleguide.rst b/docs/source/developing/styleguide.rst new file mode 100644 index 00000000000..3221813fa02 --- /dev/null +++ b/docs/source/developing/styleguide.rst @@ -0,0 +1,96 @@ +****************** +Coding Style Guide +****************** + +Follow `PEP8 `_ (the official style guide for Python). +However, if you want, you can use your own personal style guide, and then use ``pre-commit`` to format before committing. + +.. caution:: + + The CI will fail if the code is not formatted according to ``pre-commit``, so it's recommendded to use ``pre-commit``. + +Main points +=========== + +- Indent using 4 spaces. +- Use underscores in favor of camel case for all names. For classes use PascalCase. +- Limit the line length of docstrings or comments to 72 characters. +- Separate top-level functions and class definitions with two blank lines. +- Separate method definitions inside a class with a single blank line. +- Use two spaces before inline comments and one space between the pound sign and comment. +- Use a plugin for your text editor to check for/remind you of PEP8 conventions. +- When in doubt, running ``pre-commit run --all-files`` will fix a lot of things. +- Capitalize and punctuate comments and Git commit messages properly. + + +.. _pre_commit: + +What is enforced in the build +============================= + +At the time of this writing, the GitHub Actions build runs the following commands: + +.. code-block:: bash + + pre-commit run --all-files + + +It will fail if it has to make changes to the code. + +The ``pre-commit`` config should run ``ruff``, ``codespell``, and some other linters. Most of the time it should autofix problems, +but there may be some linting errors that require manual intervention. + +Imports +======= + +- Avoid using ``from ... import *``. + +- Explicitly import each module used. + +- Use relative imports to avoid hardcoding a module's package name. This greatly improves portability and is useful when importing + from another module in the current app. + +Examples +-------- + +Standard library imports: + +.. code-block:: python + + from math import sqrt + from os.path import abspath + +Core Django imports: + +.. code-block:: python + + from django.db import models + +Third-party app imports: + +.. code-block:: python + + from django_extensions.db.models import TimeStampedModel + +Good: + +.. code-block:: python + + from .models import SomeModel # explicit relative import + from otherdjangoapp.models import OtherModel # absolute import + +Bad: + +.. code-block:: python + + # intranet/apps/users/views.py + from intranet.apps.users.models import MyModel # absolute import within same package + + +References +========== + +- `Google Python Style Guide `_. +- `Google HTML/CSS Style Guide `_. +- `Google Javascript Style Guide `_. +- `PEP8: Official Python Style Guide `_. diff --git a/docs/developing/testing.rst b/docs/source/developing/testing.rst similarity index 81% rename from docs/developing/testing.rst rename to docs/source/developing/testing.rst index 5896d7181d4..a4335c1a5ea 100644 --- a/docs/developing/testing.rst +++ b/docs/source/developing/testing.rst @@ -9,6 +9,8 @@ Unit Tests For most modules, the unit tests go in ``intranet/apps//tests.py``. Currently, the sole exception is ``eighth``, where tests are broken out into several different files under ``intranet/apps/eighth/tests/``. Testing functionality that is useful for multiple tests can be found in ``intranet/test``. +.. _running-tests: + Running Tests ============= @@ -35,7 +37,13 @@ Looking at pre-existing tests can give you a good idea how to structure your tes Every test should include comments that explain, almost in narrative form, what the test is doing and what the expected results are. -Generally, there are two ways that you test Ion's code. These are not comprehensive, but should work for most cases. The first is calling methods directly; the second is making a GET or POST request to the view that you are interested in testing. The best tests utilize both. After you do either/both of these to call the code, you should use assertions to see if the code behaved as expected. A list of assertion options can be found `here `. A useful tool for making requests to the view is ``self.client``. More documentation on that can be found `here `_. Alternatively, just search through Ion's testing files for examples of using `self.client`. +Generally, there are two ways that you test Ion's code. These are not comprehensive, but should work for most cases. +The first is calling methods directly; the second is making a GET or POST request to the view that you are interested in testing. +The best tests utilize both. After you do either/both of these to call the code, you should use assertions to see if the code behaved as expected. +A list of assertion options can be found `here `_. +A useful tool for making requests to the view is ``self.client``. More documentation on that can be found +`here `_. Alternatively, just search through Ion's +testing files for examples of using `self.client`. Good Testing Examples ===================== diff --git a/docs/developing/updates.rst b/docs/source/developing/updates.rst similarity index 63% rename from docs/developing/updates.rst rename to docs/source/developing/updates.rst index ca2a314b2a7..43e2a6fda9a 100644 --- a/docs/developing/updates.rst +++ b/docs/source/developing/updates.rst @@ -5,18 +5,18 @@ Keeping things up-to-date Vendored Libraries ================== -- `CKEditor _` -- `datetimepicker _` +- `CKEditor `_ +- `datetimepicker `_ - jQuery-UI: *Note: This has very specific CSL customizations)* -- `Messenger _` -- `selectize _` -- `sortable _` +- `Messenger `_ +- `selectize `_ +- `sortable `_ Updating Top-level Requirements ================================ -If any commit changes the direct dependencies of Ion, you must update `the requirements documentation`_ to reflect the changes to Ion's dependencies. That page is organized into sections for each dependency, with a line for the package's source URL, a general description of the package, the usage of the package in Ion, and the package's license. +If any commit changes the direct dependencies of Ion, you must update `the requirements documentation `_ to reflect the changes to Ion's dependencies. That page is organized into sections for each dependency, with a line for the package's source URL, a general description of the package, the usage of the package in Ion, and the package's license. For example, here is a valid section: @@ -36,6 +36,7 @@ Additional lines may be added to identify needed actions regarding the package. Requirements for Dependencies ============================== -**All** dependencies to Ion must be licensed under an `OSI-approved open source license `_. The use of the package must be compatible with the terms of the GNU General Public License v2 (or later version). +**All** dependencies to Ion must be licensed under an `OSI-approved open source license `_. +The use of the package must be compatible with the terms of the GNU General Public License v2 (or later version). **All** direct dependencies to Ion must be reported in the requirements documentation. diff --git a/USERNAMES.md b/docs/source/developing/usernames.md similarity index 100% rename from USERNAMES.md rename to docs/source/developing/usernames.md diff --git a/docs/index.rst b/docs/source/index.rst similarity index 98% rename from docs/index.rst rename to docs/source/index.rst index e23cae37882..d06bbdf66b0 100644 --- a/docs/index.rst +++ b/docs/source/index.rst @@ -17,7 +17,7 @@ Contents setup/index architecture/index developing/index - sourcedoc/modules + reference_index Setup ----- diff --git a/docs/source/reference_index.rst b/docs/source/reference_index.rst new file mode 100644 index 00000000000..e60b414fce6 --- /dev/null +++ b/docs/source/reference_index.rst @@ -0,0 +1,21 @@ +############### +Reference Index +############### + +This is a collection of autogenerated documentation about Ion. +It's meant to be a reference - feel free to check it out! + +Middleware +~~~~~~~~~~ + +.. toctree:: + + reference_index/middleware + +Apps +~~~~ + +.. toctree:: + :glob: + + reference_index/apps/* diff --git a/docs/source/reference_index/apps/announcements.rst b/docs/source/reference_index/apps/announcements.rst new file mode 100644 index 00000000000..9cabd901aaa --- /dev/null +++ b/docs/source/reference_index/apps/announcements.rst @@ -0,0 +1,18 @@ +############# +announcements +############# + +.. currentmodule:: intranet.apps.announcements + +.. autosummary:: + :toctree: ../../reference + + notifications + serializers + urls + tests + models + forms + api + admin + views diff --git a/docs/source/reference_index/apps/api.rst b/docs/source/reference_index/apps/api.rst new file mode 100644 index 00000000000..405850245f9 --- /dev/null +++ b/docs/source/reference_index/apps/api.rst @@ -0,0 +1,14 @@ +### +api +### + +.. currentmodule:: intranet.apps.api + +.. autosummary:: + :toctree: ../../reference + + urls + tests + utils + authentication + views diff --git a/docs/source/reference_index/apps/auth.rst b/docs/source/reference_index/apps/auth.rst new file mode 100644 index 00000000000..46b173db3e0 --- /dev/null +++ b/docs/source/reference_index/apps/auth.rst @@ -0,0 +1,20 @@ +#### +auth +#### + +.. currentmodule:: intranet.apps.auth + +.. autosummary:: + :toctree: ../../reference + + decorators + urls + apps + tests + rest_permissions + management.commands.grant_admin + forms + helpers + backends + signals + views diff --git a/docs/source/reference_index/apps/bus.rst b/docs/source/reference_index/apps/bus.rst new file mode 100644 index 00000000000..9883cb89637 --- /dev/null +++ b/docs/source/reference_index/apps/bus.rst @@ -0,0 +1,20 @@ +### +bus +### + +.. currentmodule:: intranet.apps.bus + +.. autosummary:: + :toctree: ../../reference + + serializers + urls + tests + management.commands.import_routes + management.commands.reset_routes + models + tasks + api + consumers + admin + views diff --git a/docs/source/reference_index/apps/cslapps.rst b/docs/source/reference_index/apps/cslapps.rst new file mode 100644 index 00000000000..26d9e7d09b5 --- /dev/null +++ b/docs/source/reference_index/apps/cslapps.rst @@ -0,0 +1,15 @@ +####### +cslapps +####### + +.. currentmodule:: intranet.apps.cslapps + +.. autosummary:: + :toctree: ../../reference + + urls + tests + management.commands.dev_create_cslapps + models + admin + views diff --git a/docs/source/reference_index/apps/customthemes.rst b/docs/source/reference_index/apps/customthemes.rst new file mode 100644 index 00000000000..a6cde80e3c0 --- /dev/null +++ b/docs/source/reference_index/apps/customthemes.rst @@ -0,0 +1,11 @@ +############ +customthemes +############ + +.. currentmodule:: intranet.apps.customthemes + +.. autosummary:: + :toctree: ../../reference + + urls + views diff --git a/docs/source/reference_index/apps/dashboard.rst b/docs/source/reference_index/apps/dashboard.rst new file mode 100644 index 00000000000..a88ec83c21c --- /dev/null +++ b/docs/source/reference_index/apps/dashboard.rst @@ -0,0 +1,11 @@ +######### +dashboard +######### + +.. currentmodule:: intranet.apps.dashboard + +.. autosummary:: + :toctree: ../../reference + + tests + views diff --git a/docs/source/reference_index/apps/dataimport.rst b/docs/source/reference_index/apps/dataimport.rst new file mode 100644 index 00000000000..1f492d1290a --- /dev/null +++ b/docs/source/reference_index/apps/dataimport.rst @@ -0,0 +1,19 @@ +########## +dataimport +########## + +.. currentmodule:: intranet.apps.dataimport + +.. autosummary:: + :toctree: ../../reference + + apps + tests + management.commands.import_eighth + management.commands.import_students + management.commands.year_cleanup + management.commands.import_staff + management.commands.import_photos + management.commands.import_users + management.commands.import_tj_star + management.commands.delete_users diff --git a/docs/source/reference_index/apps/django.rst b/docs/source/reference_index/apps/django.rst new file mode 100644 index 00000000000..ccd8fc67294 --- /dev/null +++ b/docs/source/reference_index/apps/django.rst @@ -0,0 +1,10 @@ +###### +django +###### + +.. currentmodule:: intranet.apps.django + +.. autosummary:: + :toctree: ../../reference + + management.commands.run diff --git a/docs/source/reference_index/apps/eighth.rst b/docs/source/reference_index/apps/eighth.rst new file mode 100644 index 00000000000..65ff23d47d7 --- /dev/null +++ b/docs/source/reference_index/apps/eighth.rst @@ -0,0 +1,74 @@ +###### +eighth +###### + +.. currentmodule:: intranet.apps.eighth + +.. autosummary:: + :toctree: ../../reference + + views.monitoring + views.profile + views.admin.groups + views.admin.sponsors + views.admin.blocks + views.admin.maintenance + views.admin.general + views.admin.users + views.admin.attendance + views.admin.rooms + views.admin.hybrid + views.admin.activities + views.admin.scheduling + views.signup + views.api + views.attendance + views.routers + views.activities + notifications + serializers + urls + forms.admin.groups + forms.admin.sponsors + forms.admin.blocks + forms.admin.general + forms.admin.rooms + forms.admin.activities + forms.admin.scheduling + management.commands.absence_email + management.commands.dev_generate_signups + management.commands.find_duplicates + management.commands.signup_status_email + management.commands.remove_withdrawn_students + management.commands.generate_statistics + management.commands.dev_create_blocks + management.commands.delete_duplicate_signups + management.commands.generate_similarities + management.commands.update_counselors + management.commands.signup_statistics + models + tasks + utils + context_processors + admin + exceptions + tests.test_attendance + tests.test_signup + tests.test_exceptions + tests.eighth_test + tests.test_commands + tests.admin.test_admin_activities + tests.admin.test_admin_blocks + tests.admin.test_admin_sponsors + tests.admin.test_admin_general + tests.admin.test_admin_users + tests.admin.test_admin_groups + tests.admin.test_admin_attendance + tests.admin.test_admin_rooms + tests.admin.test_admin_maintenance + tests.admin.test_admin_scheduling + tests.test_monitoring + tests.test_activities + tests.test_routers + tests.test_profile + tests.test_general diff --git a/docs/source/reference_index/apps/emailfwd.rst b/docs/source/reference_index/apps/emailfwd.rst new file mode 100644 index 00000000000..01fc0f862f0 --- /dev/null +++ b/docs/source/reference_index/apps/emailfwd.rst @@ -0,0 +1,16 @@ +######## +emailfwd +######## + +.. currentmodule:: intranet.apps.emailfwd + +.. autosummary:: + :toctree: ../../reference + + urls + apps + tests + management.commands.get_senior_forwards + models + forms + views diff --git a/docs/source/reference_index/apps/emerg.rst b/docs/source/reference_index/apps/emerg.rst new file mode 100644 index 00000000000..9fce96bde55 --- /dev/null +++ b/docs/source/reference_index/apps/emerg.rst @@ -0,0 +1,13 @@ +##### +emerg +##### + +.. currentmodule:: intranet.apps.emerg + +.. autosummary:: + :toctree: ../../reference + + tests + tasks + api + views diff --git a/docs/source/reference_index/apps/enrichment.rst b/docs/source/reference_index/apps/enrichment.rst new file mode 100644 index 00000000000..17f815a4bd7 --- /dev/null +++ b/docs/source/reference_index/apps/enrichment.rst @@ -0,0 +1,14 @@ +########## +enrichment +########## + +.. currentmodule:: intranet.apps.enrichment + +.. autosummary:: + :toctree: ../../reference + + urls + models + forms + admin + views diff --git a/docs/source/reference_index/apps/error.rst b/docs/source/reference_index/apps/error.rst new file mode 100644 index 00000000000..13afb97b957 --- /dev/null +++ b/docs/source/reference_index/apps/error.rst @@ -0,0 +1,11 @@ +##### +error +##### + +.. currentmodule:: intranet.apps.error + +.. autosummary:: + :toctree: ../../reference + + tests + views diff --git a/docs/source/reference_index/apps/events.rst b/docs/source/reference_index/apps/events.rst new file mode 100644 index 00000000000..8a8e53cdbcb --- /dev/null +++ b/docs/source/reference_index/apps/events.rst @@ -0,0 +1,18 @@ +###### +events +###### + +.. currentmodule:: intranet.apps.events + +.. autosummary:: + :toctree: ../../reference + + notifications + urls + tests + management.commands.import_sports + models + tasks + forms + admin + views diff --git a/docs/source/reference_index/apps/features.rst b/docs/source/reference_index/apps/features.rst new file mode 100644 index 00000000000..c89e7af6fa5 --- /dev/null +++ b/docs/source/reference_index/apps/features.rst @@ -0,0 +1,16 @@ +######## +features +######## + +.. currentmodule:: intranet.apps.features + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + helpers + context_processors + admin + views diff --git a/docs/source/reference_index/apps/feedback.rst b/docs/source/reference_index/apps/feedback.rst new file mode 100644 index 00000000000..7c6290b1a9f --- /dev/null +++ b/docs/source/reference_index/apps/feedback.rst @@ -0,0 +1,15 @@ +######## +feedback +######## + +.. currentmodule:: intranet.apps.feedback + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + forms + admin + views diff --git a/docs/source/reference_index/apps/files.rst b/docs/source/reference_index/apps/files.rst new file mode 100644 index 00000000000..e38555af705 --- /dev/null +++ b/docs/source/reference_index/apps/files.rst @@ -0,0 +1,15 @@ +##### +files +##### + +.. currentmodule:: intranet.apps.files + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + forms + admin + views diff --git a/docs/source/reference_index/apps/groups.rst b/docs/source/reference_index/apps/groups.rst new file mode 100644 index 00000000000..b753531421e --- /dev/null +++ b/docs/source/reference_index/apps/groups.rst @@ -0,0 +1,14 @@ +###### +groups +###### + +.. currentmodule:: intranet.apps.groups + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + forms + views diff --git a/docs/source/reference_index/apps/itemreg.rst b/docs/source/reference_index/apps/itemreg.rst new file mode 100644 index 00000000000..4ba8edd28ad --- /dev/null +++ b/docs/source/reference_index/apps/itemreg.rst @@ -0,0 +1,17 @@ +####### +itemreg +####### + +.. currentmodule:: intranet.apps.itemreg + +.. autosummary:: + :toctree: ../../reference + + urls + apps + tests + models + forms + templatetags.texthighlight + admin + views diff --git a/docs/source/reference_index/apps/logs.rst b/docs/source/reference_index/apps/logs.rst new file mode 100644 index 00000000000..b22ab09cb55 --- /dev/null +++ b/docs/source/reference_index/apps/logs.rst @@ -0,0 +1,14 @@ +#### +logs +#### + +.. currentmodule:: intranet.apps.logs + +.. autosummary:: + :toctree: ../../reference + + urls + models + forms + admin + views diff --git a/docs/source/reference_index/apps/lostfound.rst b/docs/source/reference_index/apps/lostfound.rst new file mode 100644 index 00000000000..64a1429fbec --- /dev/null +++ b/docs/source/reference_index/apps/lostfound.rst @@ -0,0 +1,16 @@ +######### +lostfound +######### + +.. currentmodule:: intranet.apps.lostfound + +.. autosummary:: + :toctree: ../../reference + + urls + apps + tests + models + forms + admin + views diff --git a/docs/source/reference_index/apps/nomination.rst b/docs/source/reference_index/apps/nomination.rst new file mode 100644 index 00000000000..8d4702b2a0e --- /dev/null +++ b/docs/source/reference_index/apps/nomination.rst @@ -0,0 +1,14 @@ +########## +nomination +########## + +.. currentmodule:: intranet.apps.nomination + +.. autosummary:: + :toctree: ../../reference + + urls + apps + tests + models + views diff --git a/docs/source/reference_index/apps/notifications.rst b/docs/source/reference_index/apps/notifications.rst new file mode 100644 index 00000000000..d052c3fdde9 --- /dev/null +++ b/docs/source/reference_index/apps/notifications.rst @@ -0,0 +1,14 @@ +############# +notifications +############# + +.. currentmodule:: intranet.apps.notifications + +.. autosummary:: + :toctree: ../../reference + + urls + emails + models + tasks + views diff --git a/docs/source/reference_index/apps/oauth.rst b/docs/source/reference_index/apps/oauth.rst new file mode 100644 index 00000000000..720ef3cb4a3 --- /dev/null +++ b/docs/source/reference_index/apps/oauth.rst @@ -0,0 +1,14 @@ +##### +oauth +##### + +.. currentmodule:: intranet.apps.oauth + +.. autosummary:: + :toctree: ../../reference + + apps + tests + models + admin + views diff --git a/docs/source/reference_index/apps/parking.rst b/docs/source/reference_index/apps/parking.rst new file mode 100644 index 00000000000..875f98d00de --- /dev/null +++ b/docs/source/reference_index/apps/parking.rst @@ -0,0 +1,16 @@ +####### +parking +####### + +.. currentmodule:: intranet.apps.parking + +.. autosummary:: + :toctree: ../../reference + + urls + apps + tests + models + forms + admin + views diff --git a/docs/source/reference_index/apps/polls.rst b/docs/source/reference_index/apps/polls.rst new file mode 100644 index 00000000000..ef5dba56974 --- /dev/null +++ b/docs/source/reference_index/apps/polls.rst @@ -0,0 +1,15 @@ +##### +polls +##### + +.. currentmodule:: intranet.apps.polls + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + forms + admin + views diff --git a/docs/source/reference_index/apps/preferences.rst b/docs/source/reference_index/apps/preferences.rst new file mode 100644 index 00000000000..9ac9b98d22e --- /dev/null +++ b/docs/source/reference_index/apps/preferences.rst @@ -0,0 +1,14 @@ +########### +preferences +########### + +.. currentmodule:: intranet.apps.preferences + +.. autosummary:: + :toctree: ../../reference + + urls + fields + tests + forms + views diff --git a/docs/source/reference_index/apps/printing.rst b/docs/source/reference_index/apps/printing.rst new file mode 100644 index 00000000000..8c7ca914edd --- /dev/null +++ b/docs/source/reference_index/apps/printing.rst @@ -0,0 +1,15 @@ +######## +printing +######## + +.. currentmodule:: intranet.apps.printing + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + forms + admin + views diff --git a/docs/source/reference_index/apps/schedule.rst b/docs/source/reference_index/apps/schedule.rst new file mode 100644 index 00000000000..f4afa7e3bc8 --- /dev/null +++ b/docs/source/reference_index/apps/schedule.rst @@ -0,0 +1,19 @@ +######## +schedule +######## + +.. currentmodule:: intranet.apps.schedule + +.. autosummary:: + :toctree: ../../reference + + notifications + serializers + urls + tests + management.commands.schedule_notify + models + forms + api + admin + views diff --git a/docs/source/reference_index/apps/search.rst b/docs/source/reference_index/apps/search.rst new file mode 100644 index 00000000000..53f9ca625c0 --- /dev/null +++ b/docs/source/reference_index/apps/search.rst @@ -0,0 +1,13 @@ +###### +search +###### + +.. currentmodule:: intranet.apps.search + +.. autosummary:: + :toctree: ../../reference + + urls + tests + utils + views diff --git a/docs/source/reference_index/apps/seniors.rst b/docs/source/reference_index/apps/seniors.rst new file mode 100644 index 00000000000..45e6745ab9b --- /dev/null +++ b/docs/source/reference_index/apps/seniors.rst @@ -0,0 +1,17 @@ +####### +seniors +####### + +.. currentmodule:: intranet.apps.seniors + +.. autosummary:: + :toctree: ../../reference + + urls + tests + management.commands.import_colleges + management.commands.cleanup_destinations + models + forms + admin + views diff --git a/docs/source/reference_index/apps/sessionmgmt.rst b/docs/source/reference_index/apps/sessionmgmt.rst new file mode 100644 index 00000000000..24d1aa40f8d --- /dev/null +++ b/docs/source/reference_index/apps/sessionmgmt.rst @@ -0,0 +1,15 @@ +########### +sessionmgmt +########### + +.. currentmodule:: intranet.apps.sessionmgmt + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + helpers + admin + views diff --git a/docs/source/reference_index/apps/signage.rst b/docs/source/reference_index/apps/signage.rst new file mode 100644 index 00000000000..4f9431bd52c --- /dev/null +++ b/docs/source/reference_index/apps/signage.rst @@ -0,0 +1,18 @@ +####### +signage +####### + +.. currentmodule:: intranet.apps.signage + +.. autosummary:: + :toctree: ../../reference + + urls + tests + models + forms + pages + templatetags.signage + consumers + admin + views diff --git a/docs/source/reference_index/apps/templatetags.rst b/docs/source/reference_index/apps/templatetags.rst new file mode 100644 index 00000000000..ef48bddc4de --- /dev/null +++ b/docs/source/reference_index/apps/templatetags.rst @@ -0,0 +1,18 @@ +############ +templatetags +############ + +.. currentmodule:: intranet.apps.templatetags + +.. autosummary:: + :toctree: ../../reference + + tests + strings + math + form_field + dictionaries + dates + forms + newtab_links + paginate diff --git a/docs/source/reference_index/apps/users.rst b/docs/source/reference_index/apps/users.rst new file mode 100644 index 00000000000..56adfb53006 --- /dev/null +++ b/docs/source/reference_index/apps/users.rst @@ -0,0 +1,24 @@ +##### +users +##### + +.. currentmodule:: intranet.apps.users + +.. autosummary:: + :toctree: ../../reference + + courses_urls + serializers + urls + tests + management.commands.import_groups + management.commands.lock + models + forms + api + templatetags.phone_numbers + templatetags.grades + templatetags.users + renderers + admin + views diff --git a/docs/source/reference_index/apps/welcome.rst b/docs/source/reference_index/apps/welcome.rst new file mode 100644 index 00000000000..87ab56e359d --- /dev/null +++ b/docs/source/reference_index/apps/welcome.rst @@ -0,0 +1,12 @@ +####### +welcome +####### + +.. currentmodule:: intranet.apps.welcome + +.. autosummary:: + :toctree: ../../reference + + urls + tests + views diff --git a/docs/source/reference_index/middleware.rst b/docs/source/reference_index/middleware.rst new file mode 100644 index 00000000000..ffa1a543d8d --- /dev/null +++ b/docs/source/reference_index/middleware.rst @@ -0,0 +1,20 @@ +########## +Middleware +########## + +.. currentmodule:: intranet.middleware + +.. autosummary:: + :toctree: ../reference + + ~url_slashes + ~access_log + ~monitoring + ~profiler + ~session_management + ~traceback + ~ajax + ~templates + ~same_origin + ~threadlocals + ~dark_mode diff --git a/SECURITY.md b/docs/source/security.md similarity index 97% rename from SECURITY.md rename to docs/source/security.md index f29859d8781..88df92648d8 100644 --- a/SECURITY.md +++ b/docs/source/security.md @@ -1,3 +1,4 @@ +(security-policy)= # Security Policy ## Reporting a Vulnerability diff --git a/docs/setup/index.rst b/docs/source/setup/index.rst similarity index 74% rename from docs/setup/index.rst rename to docs/source/setup/index.rst index 14a150201ad..45af3f05834 100644 --- a/docs/setup/index.rst +++ b/docs/source/setup/index.rst @@ -2,6 +2,7 @@ Setup ***** .. toctree:: + :maxdepth: 2 :glob: * diff --git a/docs/setup/server.rst b/docs/source/setup/server.rst similarity index 100% rename from docs/setup/server.rst rename to docs/source/setup/server.rst diff --git a/SETUP.md b/docs/source/setup/setup.md similarity index 100% rename from SETUP.md rename to docs/source/setup/setup.md diff --git a/docs/sourcedoc/intranet.apps.announcements.rst b/docs/sourcedoc/intranet.apps.announcements.rst deleted file mode 100644 index 1d90c545af2..00000000000 --- a/docs/sourcedoc/intranet.apps.announcements.rst +++ /dev/null @@ -1,85 +0,0 @@ -intranet.apps.announcements package -=================================== - -Submodules ----------- - -intranet.apps.announcements.admin module ----------------------------------------- - -.. automodule:: intranet.apps.announcements.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.api module --------------------------------------- - -.. automodule:: intranet.apps.announcements.api - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.forms module ----------------------------------------- - -.. automodule:: intranet.apps.announcements.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.models module ------------------------------------------ - -.. automodule:: intranet.apps.announcements.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.notifications module ------------------------------------------------- - -.. automodule:: intranet.apps.announcements.notifications - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.serializers module ----------------------------------------------- - -.. automodule:: intranet.apps.announcements.serializers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.tests module ----------------------------------------- - -.. automodule:: intranet.apps.announcements.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.urls module ---------------------------------------- - -.. automodule:: intranet.apps.announcements.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.announcements.views module ----------------------------------------- - -.. automodule:: intranet.apps.announcements.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.announcements - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.api.rst b/docs/sourcedoc/intranet.apps.api.rst deleted file mode 100644 index c8b80c74565..00000000000 --- a/docs/sourcedoc/intranet.apps.api.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.api package -========================= - -Submodules ----------- - -intranet.apps.api.authentication module ---------------------------------------- - -.. automodule:: intranet.apps.api.authentication - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.api.tests module ------------------------------- - -.. automodule:: intranet.apps.api.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.api.urls module ------------------------------ - -.. automodule:: intranet.apps.api.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.api.utils module ------------------------------- - -.. automodule:: intranet.apps.api.utils - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.api.views module ------------------------------- - -.. automodule:: intranet.apps.api.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.api - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.auth.management.commands.rst b/docs/sourcedoc/intranet.apps.auth.management.commands.rst deleted file mode 100644 index c5e8c74fb51..00000000000 --- a/docs/sourcedoc/intranet.apps.auth.management.commands.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.auth.management.commands package -============================================== - -Submodules ----------- - -intranet.apps.auth.management.commands.grant\_admin module ----------------------------------------------------------- - -.. automodule:: intranet.apps.auth.management.commands.grant_admin - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.auth.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.auth.management.rst b/docs/sourcedoc/intranet.apps.auth.management.rst deleted file mode 100644 index 520aeeb9156..00000000000 --- a/docs/sourcedoc/intranet.apps.auth.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.auth.management package -===================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.auth.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.auth.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.auth.rst b/docs/sourcedoc/intranet.apps.auth.rst deleted file mode 100644 index cb474a06d54..00000000000 --- a/docs/sourcedoc/intranet.apps.auth.rst +++ /dev/null @@ -1,101 +0,0 @@ -intranet.apps.auth package -========================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.auth.management - -Submodules ----------- - -intranet.apps.auth.apps module ------------------------------- - -.. automodule:: intranet.apps.auth.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.backends module ----------------------------------- - -.. automodule:: intranet.apps.auth.backends - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.decorators module ------------------------------------- - -.. automodule:: intranet.apps.auth.decorators - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.forms module -------------------------------- - -.. automodule:: intranet.apps.auth.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.helpers module ---------------------------------- - -.. automodule:: intranet.apps.auth.helpers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.rest\_permissions module -------------------------------------------- - -.. automodule:: intranet.apps.auth.rest_permissions - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.signals module ---------------------------------- - -.. automodule:: intranet.apps.auth.signals - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.tests module -------------------------------- - -.. automodule:: intranet.apps.auth.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.urls module ------------------------------- - -.. automodule:: intranet.apps.auth.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.auth.views module -------------------------------- - -.. automodule:: intranet.apps.auth.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.auth - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.bus.management.commands.rst b/docs/sourcedoc/intranet.apps.bus.management.commands.rst deleted file mode 100644 index 14027f0f60d..00000000000 --- a/docs/sourcedoc/intranet.apps.bus.management.commands.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.apps.bus.management.commands package -============================================= - -Submodules ----------- - -intranet.apps.bus.management.commands.import\_routes module ------------------------------------------------------------ - -.. automodule:: intranet.apps.bus.management.commands.import_routes - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.management.commands.reset\_routes module ----------------------------------------------------------- - -.. automodule:: intranet.apps.bus.management.commands.reset_routes - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.bus.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.bus.management.rst b/docs/sourcedoc/intranet.apps.bus.management.rst deleted file mode 100644 index 76a4a8c0cee..00000000000 --- a/docs/sourcedoc/intranet.apps.bus.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.bus.management package -==================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.bus.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.bus.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.bus.rst b/docs/sourcedoc/intranet.apps.bus.rst deleted file mode 100644 index 20a4b215591..00000000000 --- a/docs/sourcedoc/intranet.apps.bus.rst +++ /dev/null @@ -1,93 +0,0 @@ -intranet.apps.bus package -========================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.bus.management - -Submodules ----------- - -intranet.apps.bus.admin module ------------------------------- - -.. automodule:: intranet.apps.bus.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.api module ----------------------------- - -.. automodule:: intranet.apps.bus.api - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.consumers module ----------------------------------- - -.. automodule:: intranet.apps.bus.consumers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.models module -------------------------------- - -.. automodule:: intranet.apps.bus.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.serializers module ------------------------------------- - -.. automodule:: intranet.apps.bus.serializers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.tasks module ------------------------------- - -.. automodule:: intranet.apps.bus.tasks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.tests module ------------------------------- - -.. automodule:: intranet.apps.bus.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.urls module ------------------------------ - -.. automodule:: intranet.apps.bus.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.bus.views module ------------------------------- - -.. automodule:: intranet.apps.bus.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.bus - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.cslapps.management.commands.rst b/docs/sourcedoc/intranet.apps.cslapps.management.commands.rst deleted file mode 100644 index adf909e19da..00000000000 --- a/docs/sourcedoc/intranet.apps.cslapps.management.commands.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.cslapps.management.commands package -================================================= - -Submodules ----------- - -intranet.apps.cslapps.management.commands.dev\_create\_cslapps module ---------------------------------------------------------------------- - -.. automodule:: intranet.apps.cslapps.management.commands.dev_create_cslapps - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.cslapps.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.cslapps.management.rst b/docs/sourcedoc/intranet.apps.cslapps.management.rst deleted file mode 100644 index 129b1204ba9..00000000000 --- a/docs/sourcedoc/intranet.apps.cslapps.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.cslapps.management package -======================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.cslapps.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.cslapps.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.cslapps.rst b/docs/sourcedoc/intranet.apps.cslapps.rst deleted file mode 100644 index f7811ab9c68..00000000000 --- a/docs/sourcedoc/intranet.apps.cslapps.rst +++ /dev/null @@ -1,61 +0,0 @@ -intranet.apps.cslapps package -============================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.cslapps.management - -Submodules ----------- - -intranet.apps.cslapps.admin module ----------------------------------- - -.. automodule:: intranet.apps.cslapps.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.cslapps.models module ------------------------------------ - -.. automodule:: intranet.apps.cslapps.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.cslapps.tests module ----------------------------------- - -.. automodule:: intranet.apps.cslapps.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.cslapps.urls module ---------------------------------- - -.. automodule:: intranet.apps.cslapps.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.cslapps.views module ----------------------------------- - -.. automodule:: intranet.apps.cslapps.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.cslapps - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.customthemes.rst b/docs/sourcedoc/intranet.apps.customthemes.rst deleted file mode 100644 index 52a18a72999..00000000000 --- a/docs/sourcedoc/intranet.apps.customthemes.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.apps.customthemes package -================================== - -Submodules ----------- - -intranet.apps.customthemes.urls module --------------------------------------- - -.. automodule:: intranet.apps.customthemes.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.customthemes.views module ---------------------------------------- - -.. automodule:: intranet.apps.customthemes.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.customthemes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.dashboard.rst b/docs/sourcedoc/intranet.apps.dashboard.rst deleted file mode 100644 index 6ae6ae1b474..00000000000 --- a/docs/sourcedoc/intranet.apps.dashboard.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.apps.dashboard package -=============================== - -Submodules ----------- - -intranet.apps.dashboard.tests module ------------------------------------- - -.. automodule:: intranet.apps.dashboard.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dashboard.views module ------------------------------------- - -.. automodule:: intranet.apps.dashboard.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.dashboard - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.dataimport.management.commands.rst b/docs/sourcedoc/intranet.apps.dataimport.management.commands.rst deleted file mode 100644 index de375eb6cc9..00000000000 --- a/docs/sourcedoc/intranet.apps.dataimport.management.commands.rst +++ /dev/null @@ -1,77 +0,0 @@ -intranet.apps.dataimport.management.commands package -==================================================== - -Submodules ----------- - -intranet.apps.dataimport.management.commands.delete\_users module ------------------------------------------------------------------ - -.. automodule:: intranet.apps.dataimport.management.commands.delete_users - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.import\_eighth module ------------------------------------------------------------------- - -.. automodule:: intranet.apps.dataimport.management.commands.import_eighth - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.import\_photos module ------------------------------------------------------------------- - -.. automodule:: intranet.apps.dataimport.management.commands.import_photos - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.import\_staff module ------------------------------------------------------------------ - -.. automodule:: intranet.apps.dataimport.management.commands.import_staff - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.import\_students module --------------------------------------------------------------------- - -.. automodule:: intranet.apps.dataimport.management.commands.import_students - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.import\_tj\_star module --------------------------------------------------------------------- - -.. automodule:: intranet.apps.dataimport.management.commands.import_tj_star - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.import\_users module ------------------------------------------------------------------ - -.. automodule:: intranet.apps.dataimport.management.commands.import_users - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.management.commands.year\_cleanup module ------------------------------------------------------------------ - -.. automodule:: intranet.apps.dataimport.management.commands.year_cleanup - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.dataimport.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.dataimport.management.rst b/docs/sourcedoc/intranet.apps.dataimport.management.rst deleted file mode 100644 index 1d465ff6deb..00000000000 --- a/docs/sourcedoc/intranet.apps.dataimport.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.dataimport.management package -=========================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.dataimport.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.dataimport.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.dataimport.rst b/docs/sourcedoc/intranet.apps.dataimport.rst deleted file mode 100644 index 2d7a2a5c60c..00000000000 --- a/docs/sourcedoc/intranet.apps.dataimport.rst +++ /dev/null @@ -1,37 +0,0 @@ -intranet.apps.dataimport package -================================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.dataimport.management - -Submodules ----------- - -intranet.apps.dataimport.apps module ------------------------------------- - -.. automodule:: intranet.apps.dataimport.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.dataimport.tests module -------------------------------------- - -.. automodule:: intranet.apps.dataimport.tests - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.dataimport - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.forms.admin.rst b/docs/sourcedoc/intranet.apps.eighth.forms.admin.rst deleted file mode 100644 index 9e1841c17e6..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.forms.admin.rst +++ /dev/null @@ -1,69 +0,0 @@ -intranet.apps.eighth.forms.admin package -======================================== - -Submodules ----------- - -intranet.apps.eighth.forms.admin.activities module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.forms.admin.activities - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.forms.admin.blocks module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.forms.admin.blocks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.forms.admin.general module ------------------------------------------------ - -.. automodule:: intranet.apps.eighth.forms.admin.general - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.forms.admin.groups module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.forms.admin.groups - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.forms.admin.rooms module ---------------------------------------------- - -.. automodule:: intranet.apps.eighth.forms.admin.rooms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.forms.admin.scheduling module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.forms.admin.scheduling - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.forms.admin.sponsors module ------------------------------------------------- - -.. automodule:: intranet.apps.eighth.forms.admin.sponsors - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.forms.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.forms.rst b/docs/sourcedoc/intranet.apps.eighth.forms.rst deleted file mode 100644 index af398219a61..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.forms.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.eighth.forms package -================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.eighth.forms.admin - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.forms - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.management.commands.rst b/docs/sourcedoc/intranet.apps.eighth.management.commands.rst deleted file mode 100644 index 5e20fd893fe..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.management.commands.rst +++ /dev/null @@ -1,101 +0,0 @@ -intranet.apps.eighth.management.commands package -================================================ - -Submodules ----------- - -intranet.apps.eighth.management.commands.absence\_email module --------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.absence_email - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.delete\_duplicate\_signups module --------------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.delete_duplicate_signups - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.dev\_create\_blocks module -------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.dev_create_blocks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.dev\_generate\_signups module ----------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.dev_generate_signups - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.find\_duplicates module ----------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.find_duplicates - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.generate\_similarities module ----------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.generate_similarities - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.generate\_statistics module --------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.generate_statistics - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.remove\_withdrawn\_students module ---------------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.remove_withdrawn_students - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.signup\_statistics module ------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.signup_statistics - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.signup\_status\_email module ---------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.signup_status_email - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.management.commands.update\_counselors module ------------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.management.commands.update_counselors - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.management.rst b/docs/sourcedoc/intranet.apps.eighth.management.rst deleted file mode 100644 index 813666cb82e..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.eighth.management package -======================================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.eighth.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.rst b/docs/sourcedoc/intranet.apps.eighth.rst deleted file mode 100644 index fb5d13378cd..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.rst +++ /dev/null @@ -1,96 +0,0 @@ -intranet.apps.eighth package -============================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.eighth.forms - intranet.apps.eighth.management - intranet.apps.eighth.tests - intranet.apps.eighth.views - -Submodules ----------- - -intranet.apps.eighth.admin module ---------------------------------- - -.. automodule:: intranet.apps.eighth.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.context\_processors module ------------------------------------------------ - -.. automodule:: intranet.apps.eighth.context_processors - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.exceptions module --------------------------------------- - -.. automodule:: intranet.apps.eighth.exceptions - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.models module ----------------------------------- - -.. automodule:: intranet.apps.eighth.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.notifications module ------------------------------------------ - -.. automodule:: intranet.apps.eighth.notifications - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.serializers module ---------------------------------------- - -.. automodule:: intranet.apps.eighth.serializers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tasks module ---------------------------------- - -.. automodule:: intranet.apps.eighth.tasks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.urls module --------------------------------- - -.. automodule:: intranet.apps.eighth.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.utils module ---------------------------------- - -.. automodule:: intranet.apps.eighth.utils - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.tests.admin.rst b/docs/sourcedoc/intranet.apps.eighth.tests.admin.rst deleted file mode 100644 index 2e634c2f537..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.tests.admin.rst +++ /dev/null @@ -1,93 +0,0 @@ -intranet.apps.eighth.tests.admin package -======================================== - -Submodules ----------- - -intranet.apps.eighth.tests.admin.test\_admin\_activities module ---------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_activities - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_attendance module ---------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_attendance - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_blocks module ------------------------------------------------------------ - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_blocks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_general module ------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_general - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_groups module ------------------------------------------------------------ - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_groups - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_maintenance module ----------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_maintenance - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_rooms module ----------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_rooms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_scheduling module ---------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_scheduling - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_sponsors module -------------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_sponsors - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.admin.test\_admin\_users module ----------------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.admin.test_admin_users - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.tests.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.tests.rst b/docs/sourcedoc/intranet.apps.eighth.tests.rst deleted file mode 100644 index a29af75b3f2..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.tests.rst +++ /dev/null @@ -1,101 +0,0 @@ -intranet.apps.eighth.tests package -================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.eighth.tests.admin - -Submodules ----------- - -intranet.apps.eighth.tests.eighth\_test module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.eighth_test - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_activities module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.test_activities - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_attendance module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.test_attendance - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_commands module ------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.test_commands - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_exceptions module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.test_exceptions - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_general module ------------------------------------------------ - -.. automodule:: intranet.apps.eighth.tests.test_general - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_monitoring module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.test_monitoring - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_profile module ------------------------------------------------ - -.. automodule:: intranet.apps.eighth.tests.test_profile - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_routers module ------------------------------------------------ - -.. automodule:: intranet.apps.eighth.tests.test_routers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.tests.test\_signup module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.tests.test_signup - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.tests - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.views.admin.rst b/docs/sourcedoc/intranet.apps.eighth.views.admin.rst deleted file mode 100644 index ec5ce6c0b4e..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.views.admin.rst +++ /dev/null @@ -1,101 +0,0 @@ -intranet.apps.eighth.views.admin package -======================================== - -Submodules ----------- - -intranet.apps.eighth.views.admin.activities module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.activities - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.attendance module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.attendance - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.blocks module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.blocks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.general module ------------------------------------------------ - -.. automodule:: intranet.apps.eighth.views.admin.general - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.groups module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.groups - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.hybrid module ----------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.hybrid - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.maintenance module ---------------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.maintenance - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.rooms module ---------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.rooms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.scheduling module --------------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.scheduling - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.sponsors module ------------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.sponsors - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.admin.users module ---------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.admin.users - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.views.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.eighth.views.rst b/docs/sourcedoc/intranet.apps.eighth.views.rst deleted file mode 100644 index 70c3090dfcd..00000000000 --- a/docs/sourcedoc/intranet.apps.eighth.views.rst +++ /dev/null @@ -1,77 +0,0 @@ -intranet.apps.eighth.views package -================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.eighth.views.admin - -Submodules ----------- - -intranet.apps.eighth.views.activities module --------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.activities - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.api module -------------------------------------- - -.. automodule:: intranet.apps.eighth.views.api - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.attendance module --------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.attendance - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.monitoring module --------------------------------------------- - -.. automodule:: intranet.apps.eighth.views.monitoring - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.profile module ------------------------------------------ - -.. automodule:: intranet.apps.eighth.views.profile - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.routers module ------------------------------------------ - -.. automodule:: intranet.apps.eighth.views.routers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.eighth.views.signup module ----------------------------------------- - -.. automodule:: intranet.apps.eighth.views.signup - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.eighth.views - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.emailfwd.management.commands.rst b/docs/sourcedoc/intranet.apps.emailfwd.management.commands.rst deleted file mode 100644 index de6b12b3e74..00000000000 --- a/docs/sourcedoc/intranet.apps.emailfwd.management.commands.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.emailfwd.management.commands package -================================================== - -Submodules ----------- - -intranet.apps.emailfwd.management.commands.get\_senior\_forwards module ------------------------------------------------------------------------ - -.. automodule:: intranet.apps.emailfwd.management.commands.get_senior_forwards - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.emailfwd.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.emailfwd.management.rst b/docs/sourcedoc/intranet.apps.emailfwd.management.rst deleted file mode 100644 index 4e1834f37f4..00000000000 --- a/docs/sourcedoc/intranet.apps.emailfwd.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.emailfwd.management package -========================================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.emailfwd.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.emailfwd.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.emailfwd.rst b/docs/sourcedoc/intranet.apps.emailfwd.rst deleted file mode 100644 index a58bcae5e4c..00000000000 --- a/docs/sourcedoc/intranet.apps.emailfwd.rst +++ /dev/null @@ -1,69 +0,0 @@ -intranet.apps.emailfwd package -============================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.emailfwd.management - -Submodules ----------- - -intranet.apps.emailfwd.apps module ----------------------------------- - -.. automodule:: intranet.apps.emailfwd.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emailfwd.forms module ------------------------------------ - -.. automodule:: intranet.apps.emailfwd.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emailfwd.models module ------------------------------------- - -.. automodule:: intranet.apps.emailfwd.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emailfwd.tests module ------------------------------------ - -.. automodule:: intranet.apps.emailfwd.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emailfwd.urls module ----------------------------------- - -.. automodule:: intranet.apps.emailfwd.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emailfwd.views module ------------------------------------ - -.. automodule:: intranet.apps.emailfwd.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.emailfwd - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.emerg.rst b/docs/sourcedoc/intranet.apps.emerg.rst deleted file mode 100644 index 4232ed6d4a0..00000000000 --- a/docs/sourcedoc/intranet.apps.emerg.rst +++ /dev/null @@ -1,45 +0,0 @@ -intranet.apps.emerg package -=========================== - -Submodules ----------- - -intranet.apps.emerg.api module ------------------------------- - -.. automodule:: intranet.apps.emerg.api - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emerg.tasks module --------------------------------- - -.. automodule:: intranet.apps.emerg.tasks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emerg.tests module --------------------------------- - -.. automodule:: intranet.apps.emerg.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.emerg.views module --------------------------------- - -.. automodule:: intranet.apps.emerg.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.emerg - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.enrichment.rst b/docs/sourcedoc/intranet.apps.enrichment.rst deleted file mode 100644 index 789f348bc00..00000000000 --- a/docs/sourcedoc/intranet.apps.enrichment.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.enrichment package -================================ - -Submodules ----------- - -intranet.apps.enrichment.admin module -------------------------------------- - -.. automodule:: intranet.apps.enrichment.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.enrichment.forms module -------------------------------------- - -.. automodule:: intranet.apps.enrichment.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.enrichment.models module --------------------------------------- - -.. automodule:: intranet.apps.enrichment.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.enrichment.urls module ------------------------------------- - -.. automodule:: intranet.apps.enrichment.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.enrichment.views module -------------------------------------- - -.. automodule:: intranet.apps.enrichment.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.enrichment - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.error.rst b/docs/sourcedoc/intranet.apps.error.rst deleted file mode 100644 index 87ecaed4177..00000000000 --- a/docs/sourcedoc/intranet.apps.error.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.apps.error package -=========================== - -Submodules ----------- - -intranet.apps.error.tests module --------------------------------- - -.. automodule:: intranet.apps.error.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.error.views module --------------------------------- - -.. automodule:: intranet.apps.error.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.error - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.events.management.commands.rst b/docs/sourcedoc/intranet.apps.events.management.commands.rst deleted file mode 100644 index 5a948248af8..00000000000 --- a/docs/sourcedoc/intranet.apps.events.management.commands.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.events.management.commands package -================================================ - -Submodules ----------- - -intranet.apps.events.management.commands.import\_sports module --------------------------------------------------------------- - -.. automodule:: intranet.apps.events.management.commands.import_sports - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.events.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.events.management.rst b/docs/sourcedoc/intranet.apps.events.management.rst deleted file mode 100644 index 2a68c6f6e9e..00000000000 --- a/docs/sourcedoc/intranet.apps.events.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.events.management package -======================================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.events.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.events.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.events.rst b/docs/sourcedoc/intranet.apps.events.rst deleted file mode 100644 index 98b5f7c6fb7..00000000000 --- a/docs/sourcedoc/intranet.apps.events.rst +++ /dev/null @@ -1,85 +0,0 @@ -intranet.apps.events package -============================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.events.management - -Submodules ----------- - -intranet.apps.events.admin module ---------------------------------- - -.. automodule:: intranet.apps.events.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.forms module ---------------------------------- - -.. automodule:: intranet.apps.events.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.models module ----------------------------------- - -.. automodule:: intranet.apps.events.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.notifications module ------------------------------------------ - -.. automodule:: intranet.apps.events.notifications - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.tasks module ---------------------------------- - -.. automodule:: intranet.apps.events.tasks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.tests module ---------------------------------- - -.. automodule:: intranet.apps.events.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.urls module --------------------------------- - -.. automodule:: intranet.apps.events.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.events.views module ---------------------------------- - -.. automodule:: intranet.apps.events.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.events - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.features.rst b/docs/sourcedoc/intranet.apps.features.rst deleted file mode 100644 index 44a9d6a1e5a..00000000000 --- a/docs/sourcedoc/intranet.apps.features.rst +++ /dev/null @@ -1,69 +0,0 @@ -intranet.apps.features package -============================== - -Submodules ----------- - -intranet.apps.features.admin module ------------------------------------ - -.. automodule:: intranet.apps.features.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.features.context\_processors module -------------------------------------------------- - -.. automodule:: intranet.apps.features.context_processors - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.features.helpers module -------------------------------------- - -.. automodule:: intranet.apps.features.helpers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.features.models module ------------------------------------- - -.. automodule:: intranet.apps.features.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.features.tests module ------------------------------------ - -.. automodule:: intranet.apps.features.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.features.urls module ----------------------------------- - -.. automodule:: intranet.apps.features.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.features.views module ------------------------------------ - -.. automodule:: intranet.apps.features.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.features - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.feedback.rst b/docs/sourcedoc/intranet.apps.feedback.rst deleted file mode 100644 index eb3f4c2013e..00000000000 --- a/docs/sourcedoc/intranet.apps.feedback.rst +++ /dev/null @@ -1,61 +0,0 @@ -intranet.apps.feedback package -============================== - -Submodules ----------- - -intranet.apps.feedback.admin module ------------------------------------ - -.. automodule:: intranet.apps.feedback.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.feedback.forms module ------------------------------------ - -.. automodule:: intranet.apps.feedback.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.feedback.models module ------------------------------------- - -.. automodule:: intranet.apps.feedback.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.feedback.tests module ------------------------------------ - -.. automodule:: intranet.apps.feedback.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.feedback.urls module ----------------------------------- - -.. automodule:: intranet.apps.feedback.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.feedback.views module ------------------------------------ - -.. automodule:: intranet.apps.feedback.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.feedback - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.files.rst b/docs/sourcedoc/intranet.apps.files.rst deleted file mode 100644 index 6ca8c9c21e9..00000000000 --- a/docs/sourcedoc/intranet.apps.files.rst +++ /dev/null @@ -1,61 +0,0 @@ -intranet.apps.files package -=========================== - -Submodules ----------- - -intranet.apps.files.admin module --------------------------------- - -.. automodule:: intranet.apps.files.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.files.forms module --------------------------------- - -.. automodule:: intranet.apps.files.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.files.models module ---------------------------------- - -.. automodule:: intranet.apps.files.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.files.tests module --------------------------------- - -.. automodule:: intranet.apps.files.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.files.urls module -------------------------------- - -.. automodule:: intranet.apps.files.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.files.views module --------------------------------- - -.. automodule:: intranet.apps.files.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.files - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.groups.rst b/docs/sourcedoc/intranet.apps.groups.rst deleted file mode 100644 index d1f8036ca82..00000000000 --- a/docs/sourcedoc/intranet.apps.groups.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.groups package -============================ - -Submodules ----------- - -intranet.apps.groups.forms module ---------------------------------- - -.. automodule:: intranet.apps.groups.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.groups.models module ----------------------------------- - -.. automodule:: intranet.apps.groups.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.groups.tests module ---------------------------------- - -.. automodule:: intranet.apps.groups.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.groups.urls module --------------------------------- - -.. automodule:: intranet.apps.groups.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.groups.views module ---------------------------------- - -.. automodule:: intranet.apps.groups.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.groups - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.itemreg.rst b/docs/sourcedoc/intranet.apps.itemreg.rst deleted file mode 100644 index 97b116b495f..00000000000 --- a/docs/sourcedoc/intranet.apps.itemreg.rst +++ /dev/null @@ -1,77 +0,0 @@ -intranet.apps.itemreg package -============================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.itemreg.templatetags - -Submodules ----------- - -intranet.apps.itemreg.admin module ----------------------------------- - -.. automodule:: intranet.apps.itemreg.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.itemreg.apps module ---------------------------------- - -.. automodule:: intranet.apps.itemreg.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.itemreg.forms module ----------------------------------- - -.. automodule:: intranet.apps.itemreg.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.itemreg.models module ------------------------------------ - -.. automodule:: intranet.apps.itemreg.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.itemreg.tests module ----------------------------------- - -.. automodule:: intranet.apps.itemreg.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.itemreg.urls module ---------------------------------- - -.. automodule:: intranet.apps.itemreg.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.itemreg.views module ----------------------------------- - -.. automodule:: intranet.apps.itemreg.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.itemreg - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.itemreg.templatetags.rst b/docs/sourcedoc/intranet.apps.itemreg.templatetags.rst deleted file mode 100644 index c389be430a2..00000000000 --- a/docs/sourcedoc/intranet.apps.itemreg.templatetags.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.itemreg.templatetags package -========================================== - -Submodules ----------- - -intranet.apps.itemreg.templatetags.texthighlight module -------------------------------------------------------- - -.. automodule:: intranet.apps.itemreg.templatetags.texthighlight - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.itemreg.templatetags - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.logs.rst b/docs/sourcedoc/intranet.apps.logs.rst deleted file mode 100644 index 18e0dc5b069..00000000000 --- a/docs/sourcedoc/intranet.apps.logs.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.logs package -========================== - -Submodules ----------- - -intranet.apps.logs.admin module -------------------------------- - -.. automodule:: intranet.apps.logs.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.logs.forms module -------------------------------- - -.. automodule:: intranet.apps.logs.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.logs.models module --------------------------------- - -.. automodule:: intranet.apps.logs.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.logs.urls module ------------------------------- - -.. automodule:: intranet.apps.logs.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.logs.views module -------------------------------- - -.. automodule:: intranet.apps.logs.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.logs - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.lostfound.rst b/docs/sourcedoc/intranet.apps.lostfound.rst deleted file mode 100644 index ec4a293a0af..00000000000 --- a/docs/sourcedoc/intranet.apps.lostfound.rst +++ /dev/null @@ -1,69 +0,0 @@ -intranet.apps.lostfound package -=============================== - -Submodules ----------- - -intranet.apps.lostfound.admin module ------------------------------------- - -.. automodule:: intranet.apps.lostfound.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.lostfound.apps module ------------------------------------ - -.. automodule:: intranet.apps.lostfound.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.lostfound.forms module ------------------------------------- - -.. automodule:: intranet.apps.lostfound.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.lostfound.models module -------------------------------------- - -.. automodule:: intranet.apps.lostfound.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.lostfound.tests module ------------------------------------- - -.. automodule:: intranet.apps.lostfound.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.lostfound.urls module ------------------------------------ - -.. automodule:: intranet.apps.lostfound.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.lostfound.views module ------------------------------------- - -.. automodule:: intranet.apps.lostfound.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.lostfound - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.nomination.rst b/docs/sourcedoc/intranet.apps.nomination.rst deleted file mode 100644 index 2c11f0fd21f..00000000000 --- a/docs/sourcedoc/intranet.apps.nomination.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.nomination package -================================ - -Submodules ----------- - -intranet.apps.nomination.apps module ------------------------------------- - -.. automodule:: intranet.apps.nomination.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.nomination.models module --------------------------------------- - -.. automodule:: intranet.apps.nomination.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.nomination.tests module -------------------------------------- - -.. automodule:: intranet.apps.nomination.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.nomination.urls module ------------------------------------- - -.. automodule:: intranet.apps.nomination.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.nomination.views module -------------------------------------- - -.. automodule:: intranet.apps.nomination.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.nomination - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.notifications.rst b/docs/sourcedoc/intranet.apps.notifications.rst deleted file mode 100644 index 3f5e527d432..00000000000 --- a/docs/sourcedoc/intranet.apps.notifications.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.notifications package -=================================== - -Submodules ----------- - -intranet.apps.notifications.emails module ------------------------------------------ - -.. automodule:: intranet.apps.notifications.emails - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.notifications.models module ------------------------------------------ - -.. automodule:: intranet.apps.notifications.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.notifications.tasks module ----------------------------------------- - -.. automodule:: intranet.apps.notifications.tasks - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.notifications.urls module ---------------------------------------- - -.. automodule:: intranet.apps.notifications.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.notifications.views module ----------------------------------------- - -.. automodule:: intranet.apps.notifications.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.notifications - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.oauth.rst b/docs/sourcedoc/intranet.apps.oauth.rst deleted file mode 100644 index 4b3b094232d..00000000000 --- a/docs/sourcedoc/intranet.apps.oauth.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.oauth package -=========================== - -Submodules ----------- - -intranet.apps.oauth.admin module --------------------------------- - -.. automodule:: intranet.apps.oauth.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.oauth.apps module -------------------------------- - -.. automodule:: intranet.apps.oauth.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.oauth.models module ---------------------------------- - -.. automodule:: intranet.apps.oauth.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.oauth.tests module --------------------------------- - -.. automodule:: intranet.apps.oauth.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.oauth.views module --------------------------------- - -.. automodule:: intranet.apps.oauth.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.oauth - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.parking.rst b/docs/sourcedoc/intranet.apps.parking.rst deleted file mode 100644 index 71b36f10fd3..00000000000 --- a/docs/sourcedoc/intranet.apps.parking.rst +++ /dev/null @@ -1,69 +0,0 @@ -intranet.apps.parking package -============================= - -Submodules ----------- - -intranet.apps.parking.admin module ----------------------------------- - -.. automodule:: intranet.apps.parking.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.parking.apps module ---------------------------------- - -.. automodule:: intranet.apps.parking.apps - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.parking.forms module ----------------------------------- - -.. automodule:: intranet.apps.parking.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.parking.models module ------------------------------------ - -.. automodule:: intranet.apps.parking.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.parking.tests module ----------------------------------- - -.. automodule:: intranet.apps.parking.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.parking.urls module ---------------------------------- - -.. automodule:: intranet.apps.parking.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.parking.views module ----------------------------------- - -.. automodule:: intranet.apps.parking.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.parking - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.polls.rst b/docs/sourcedoc/intranet.apps.polls.rst deleted file mode 100644 index d5e430efb60..00000000000 --- a/docs/sourcedoc/intranet.apps.polls.rst +++ /dev/null @@ -1,61 +0,0 @@ -intranet.apps.polls package -=========================== - -Submodules ----------- - -intranet.apps.polls.admin module --------------------------------- - -.. automodule:: intranet.apps.polls.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.polls.forms module --------------------------------- - -.. automodule:: intranet.apps.polls.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.polls.models module ---------------------------------- - -.. automodule:: intranet.apps.polls.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.polls.tests module --------------------------------- - -.. automodule:: intranet.apps.polls.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.polls.urls module -------------------------------- - -.. automodule:: intranet.apps.polls.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.polls.views module --------------------------------- - -.. automodule:: intranet.apps.polls.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.polls - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.preferences.rst b/docs/sourcedoc/intranet.apps.preferences.rst deleted file mode 100644 index 245e0cbe9eb..00000000000 --- a/docs/sourcedoc/intranet.apps.preferences.rst +++ /dev/null @@ -1,53 +0,0 @@ -intranet.apps.preferences package -================================= - -Submodules ----------- - -intranet.apps.preferences.fields module ---------------------------------------- - -.. automodule:: intranet.apps.preferences.fields - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.preferences.forms module --------------------------------------- - -.. automodule:: intranet.apps.preferences.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.preferences.tests module --------------------------------------- - -.. automodule:: intranet.apps.preferences.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.preferences.urls module -------------------------------------- - -.. automodule:: intranet.apps.preferences.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.preferences.views module --------------------------------------- - -.. automodule:: intranet.apps.preferences.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.preferences - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.printing.rst b/docs/sourcedoc/intranet.apps.printing.rst deleted file mode 100644 index 203267d42e5..00000000000 --- a/docs/sourcedoc/intranet.apps.printing.rst +++ /dev/null @@ -1,61 +0,0 @@ -intranet.apps.printing package -============================== - -Submodules ----------- - -intranet.apps.printing.admin module ------------------------------------ - -.. automodule:: intranet.apps.printing.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.printing.forms module ------------------------------------ - -.. automodule:: intranet.apps.printing.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.printing.models module ------------------------------------- - -.. automodule:: intranet.apps.printing.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.printing.tests module ------------------------------------ - -.. automodule:: intranet.apps.printing.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.printing.urls module ----------------------------------- - -.. automodule:: intranet.apps.printing.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.printing.views module ------------------------------------ - -.. automodule:: intranet.apps.printing.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.printing - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.rst b/docs/sourcedoc/intranet.apps.rst deleted file mode 100644 index a9060e44104..00000000000 --- a/docs/sourcedoc/intranet.apps.rst +++ /dev/null @@ -1,64 +0,0 @@ -intranet.apps package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.announcements - intranet.apps.api - intranet.apps.auth - intranet.apps.bus - intranet.apps.cslapps - intranet.apps.customthemes - intranet.apps.dashboard - intranet.apps.dataimport - intranet.apps.eighth - intranet.apps.emailfwd - intranet.apps.emerg - intranet.apps.enrichment - intranet.apps.error - intranet.apps.events - intranet.apps.features - intranet.apps.feedback - intranet.apps.files - intranet.apps.groups - intranet.apps.itemreg - intranet.apps.logs - intranet.apps.lostfound - intranet.apps.nomination - intranet.apps.notifications - intranet.apps.oauth - intranet.apps.parking - intranet.apps.polls - intranet.apps.preferences - intranet.apps.printing - intranet.apps.schedule - intranet.apps.search - intranet.apps.seniors - intranet.apps.sessionmgmt - intranet.apps.signage - intranet.apps.templatetags - intranet.apps.users - intranet.apps.welcome - -Submodules ----------- - -intranet.apps.context\_processors module ----------------------------------------- - -.. automodule:: intranet.apps.context_processors - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.schedule.management.commands.rst b/docs/sourcedoc/intranet.apps.schedule.management.commands.rst deleted file mode 100644 index 89ed52a0dd1..00000000000 --- a/docs/sourcedoc/intranet.apps.schedule.management.commands.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.schedule.management.commands package -================================================== - -Submodules ----------- - -intranet.apps.schedule.management.commands.schedule\_notify module ------------------------------------------------------------------- - -.. automodule:: intranet.apps.schedule.management.commands.schedule_notify - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.schedule.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.schedule.management.rst b/docs/sourcedoc/intranet.apps.schedule.management.rst deleted file mode 100644 index 6c86dc01daf..00000000000 --- a/docs/sourcedoc/intranet.apps.schedule.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.schedule.management package -========================================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.schedule.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.schedule.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.schedule.rst b/docs/sourcedoc/intranet.apps.schedule.rst deleted file mode 100644 index 13257fcc2e8..00000000000 --- a/docs/sourcedoc/intranet.apps.schedule.rst +++ /dev/null @@ -1,93 +0,0 @@ -intranet.apps.schedule package -============================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.schedule.management - -Submodules ----------- - -intranet.apps.schedule.admin module ------------------------------------ - -.. automodule:: intranet.apps.schedule.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.api module ---------------------------------- - -.. automodule:: intranet.apps.schedule.api - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.forms module ------------------------------------ - -.. automodule:: intranet.apps.schedule.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.models module ------------------------------------- - -.. automodule:: intranet.apps.schedule.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.notifications module -------------------------------------------- - -.. automodule:: intranet.apps.schedule.notifications - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.serializers module ------------------------------------------ - -.. automodule:: intranet.apps.schedule.serializers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.tests module ------------------------------------ - -.. automodule:: intranet.apps.schedule.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.urls module ----------------------------------- - -.. automodule:: intranet.apps.schedule.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.schedule.views module ------------------------------------ - -.. automodule:: intranet.apps.schedule.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.schedule - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.search.rst b/docs/sourcedoc/intranet.apps.search.rst deleted file mode 100644 index bc55d23e2fa..00000000000 --- a/docs/sourcedoc/intranet.apps.search.rst +++ /dev/null @@ -1,45 +0,0 @@ -intranet.apps.search package -============================ - -Submodules ----------- - -intranet.apps.search.tests module ---------------------------------- - -.. automodule:: intranet.apps.search.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.search.urls module --------------------------------- - -.. automodule:: intranet.apps.search.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.search.utils module ---------------------------------- - -.. automodule:: intranet.apps.search.utils - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.search.views module ---------------------------------- - -.. automodule:: intranet.apps.search.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.search - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.seniors.management.commands.rst b/docs/sourcedoc/intranet.apps.seniors.management.commands.rst deleted file mode 100644 index 787cde9fd38..00000000000 --- a/docs/sourcedoc/intranet.apps.seniors.management.commands.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.apps.seniors.management.commands package -================================================= - -Submodules ----------- - -intranet.apps.seniors.management.commands.cleanup\_destinations module ----------------------------------------------------------------------- - -.. automodule:: intranet.apps.seniors.management.commands.cleanup_destinations - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.seniors.management.commands.import\_colleges module ------------------------------------------------------------------ - -.. automodule:: intranet.apps.seniors.management.commands.import_colleges - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.seniors.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.seniors.management.rst b/docs/sourcedoc/intranet.apps.seniors.management.rst deleted file mode 100644 index b403f1fb432..00000000000 --- a/docs/sourcedoc/intranet.apps.seniors.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.seniors.management package -======================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.seniors.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.seniors.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.seniors.rst b/docs/sourcedoc/intranet.apps.seniors.rst deleted file mode 100644 index 108fb2db02e..00000000000 --- a/docs/sourcedoc/intranet.apps.seniors.rst +++ /dev/null @@ -1,69 +0,0 @@ -intranet.apps.seniors package -============================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.seniors.management - -Submodules ----------- - -intranet.apps.seniors.admin module ----------------------------------- - -.. automodule:: intranet.apps.seniors.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.seniors.forms module ----------------------------------- - -.. automodule:: intranet.apps.seniors.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.seniors.models module ------------------------------------ - -.. automodule:: intranet.apps.seniors.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.seniors.tests module ----------------------------------- - -.. automodule:: intranet.apps.seniors.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.seniors.urls module ---------------------------------- - -.. automodule:: intranet.apps.seniors.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.seniors.views module ----------------------------------- - -.. automodule:: intranet.apps.seniors.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.seniors - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.sessionmgmt.rst b/docs/sourcedoc/intranet.apps.sessionmgmt.rst deleted file mode 100644 index bcfff526d75..00000000000 --- a/docs/sourcedoc/intranet.apps.sessionmgmt.rst +++ /dev/null @@ -1,61 +0,0 @@ -intranet.apps.sessionmgmt package -================================= - -Submodules ----------- - -intranet.apps.sessionmgmt.admin module --------------------------------------- - -.. automodule:: intranet.apps.sessionmgmt.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.sessionmgmt.helpers module ----------------------------------------- - -.. automodule:: intranet.apps.sessionmgmt.helpers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.sessionmgmt.models module ---------------------------------------- - -.. automodule:: intranet.apps.sessionmgmt.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.sessionmgmt.tests module --------------------------------------- - -.. automodule:: intranet.apps.sessionmgmt.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.sessionmgmt.urls module -------------------------------------- - -.. automodule:: intranet.apps.sessionmgmt.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.sessionmgmt.views module --------------------------------------- - -.. automodule:: intranet.apps.sessionmgmt.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.sessionmgmt - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.signage.rst b/docs/sourcedoc/intranet.apps.signage.rst deleted file mode 100644 index 0c195c42cc4..00000000000 --- a/docs/sourcedoc/intranet.apps.signage.rst +++ /dev/null @@ -1,85 +0,0 @@ -intranet.apps.signage package -============================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.signage.templatetags - -Submodules ----------- - -intranet.apps.signage.admin module ----------------------------------- - -.. automodule:: intranet.apps.signage.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.consumers module --------------------------------------- - -.. automodule:: intranet.apps.signage.consumers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.forms module ----------------------------------- - -.. automodule:: intranet.apps.signage.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.models module ------------------------------------ - -.. automodule:: intranet.apps.signage.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.pages module ----------------------------------- - -.. automodule:: intranet.apps.signage.pages - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.tests module ----------------------------------- - -.. automodule:: intranet.apps.signage.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.urls module ---------------------------------- - -.. automodule:: intranet.apps.signage.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.signage.views module ----------------------------------- - -.. automodule:: intranet.apps.signage.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.signage - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.signage.templatetags.rst b/docs/sourcedoc/intranet.apps.signage.templatetags.rst deleted file mode 100644 index c0f2920c237..00000000000 --- a/docs/sourcedoc/intranet.apps.signage.templatetags.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.apps.signage.templatetags package -========================================== - -Submodules ----------- - -intranet.apps.signage.templatetags.signage module -------------------------------------------------- - -.. automodule:: intranet.apps.signage.templatetags.signage - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.signage.templatetags - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.templatetags.rst b/docs/sourcedoc/intranet.apps.templatetags.rst deleted file mode 100644 index a5820320a6b..00000000000 --- a/docs/sourcedoc/intranet.apps.templatetags.rst +++ /dev/null @@ -1,85 +0,0 @@ -intranet.apps.templatetags package -================================== - -Submodules ----------- - -intranet.apps.templatetags.dates module ---------------------------------------- - -.. automodule:: intranet.apps.templatetags.dates - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.dictionaries module ----------------------------------------------- - -.. automodule:: intranet.apps.templatetags.dictionaries - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.form\_field module ---------------------------------------------- - -.. automodule:: intranet.apps.templatetags.form_field - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.forms module ---------------------------------------- - -.. automodule:: intranet.apps.templatetags.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.math module --------------------------------------- - -.. automodule:: intranet.apps.templatetags.math - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.newtab\_links module ------------------------------------------------ - -.. automodule:: intranet.apps.templatetags.newtab_links - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.paginate module ------------------------------------------- - -.. automodule:: intranet.apps.templatetags.paginate - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.strings module ------------------------------------------ - -.. automodule:: intranet.apps.templatetags.strings - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.templatetags.tests module ---------------------------------------- - -.. automodule:: intranet.apps.templatetags.tests - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.templatetags - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.users.management.commands.rst b/docs/sourcedoc/intranet.apps.users.management.commands.rst deleted file mode 100644 index 62155120217..00000000000 --- a/docs/sourcedoc/intranet.apps.users.management.commands.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.apps.users.management.commands package -=============================================== - -Submodules ----------- - -intranet.apps.users.management.commands.import\_groups module -------------------------------------------------------------- - -.. automodule:: intranet.apps.users.management.commands.import_groups - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.management.commands.lock module ---------------------------------------------------- - -.. automodule:: intranet.apps.users.management.commands.lock - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.users.management.commands - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.users.management.rst b/docs/sourcedoc/intranet.apps.users.management.rst deleted file mode 100644 index d5422432620..00000000000 --- a/docs/sourcedoc/intranet.apps.users.management.rst +++ /dev/null @@ -1,18 +0,0 @@ -intranet.apps.users.management package -====================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.users.management.commands - -Module contents ---------------- - -.. automodule:: intranet.apps.users.management - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.users.rst b/docs/sourcedoc/intranet.apps.users.rst deleted file mode 100644 index f95f5f97436..00000000000 --- a/docs/sourcedoc/intranet.apps.users.rst +++ /dev/null @@ -1,102 +0,0 @@ -intranet.apps.users package -=========================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps.users.management - intranet.apps.users.templatetags - -Submodules ----------- - -intranet.apps.users.admin module --------------------------------- - -.. automodule:: intranet.apps.users.admin - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.api module ------------------------------- - -.. automodule:: intranet.apps.users.api - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.courses\_urls module ----------------------------------------- - -.. automodule:: intranet.apps.users.courses_urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.forms module --------------------------------- - -.. automodule:: intranet.apps.users.forms - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.models module ---------------------------------- - -.. automodule:: intranet.apps.users.models - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.renderers module ------------------------------------- - -.. automodule:: intranet.apps.users.renderers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.serializers module --------------------------------------- - -.. automodule:: intranet.apps.users.serializers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.tests module --------------------------------- - -.. automodule:: intranet.apps.users.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.urls module -------------------------------- - -.. automodule:: intranet.apps.users.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.views module --------------------------------- - -.. automodule:: intranet.apps.users.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.users - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.users.templatetags.rst b/docs/sourcedoc/intranet.apps.users.templatetags.rst deleted file mode 100644 index 670d206b67e..00000000000 --- a/docs/sourcedoc/intranet.apps.users.templatetags.rst +++ /dev/null @@ -1,37 +0,0 @@ -intranet.apps.users.templatetags package -======================================== - -Submodules ----------- - -intranet.apps.users.templatetags.grades module ----------------------------------------------- - -.. automodule:: intranet.apps.users.templatetags.grades - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.templatetags.phone\_numbers module ------------------------------------------------------- - -.. automodule:: intranet.apps.users.templatetags.phone_numbers - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.users.templatetags.users module ---------------------------------------------- - -.. automodule:: intranet.apps.users.templatetags.users - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.users.templatetags - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.apps.welcome.rst b/docs/sourcedoc/intranet.apps.welcome.rst deleted file mode 100644 index 4fd49dadd8f..00000000000 --- a/docs/sourcedoc/intranet.apps.welcome.rst +++ /dev/null @@ -1,37 +0,0 @@ -intranet.apps.welcome package -============================= - -Submodules ----------- - -intranet.apps.welcome.tests module ----------------------------------- - -.. automodule:: intranet.apps.welcome.tests - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.welcome.urls module ---------------------------------- - -.. automodule:: intranet.apps.welcome.urls - :members: - :undoc-members: - :show-inheritance: - -intranet.apps.welcome.views module ----------------------------------- - -.. automodule:: intranet.apps.welcome.views - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.apps.welcome - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.middleware.rst b/docs/sourcedoc/intranet.middleware.rst deleted file mode 100644 index fdacc55e1b5..00000000000 --- a/docs/sourcedoc/intranet.middleware.rst +++ /dev/null @@ -1,101 +0,0 @@ -intranet.middleware package -=========================== - -Submodules ----------- - -intranet.middleware.access\_log module --------------------------------------- - -.. automodule:: intranet.middleware.access_log - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.ajax module -------------------------------- - -.. automodule:: intranet.middleware.ajax - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.dark\_mode module -------------------------------------- - -.. automodule:: intranet.middleware.dark_mode - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.monitoring module -------------------------------------- - -.. automodule:: intranet.middleware.monitoring - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.profiler module ------------------------------------ - -.. automodule:: intranet.middleware.profiler - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.same\_origin module ---------------------------------------- - -.. automodule:: intranet.middleware.same_origin - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.session\_management module ----------------------------------------------- - -.. automodule:: intranet.middleware.session_management - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.templates module ------------------------------------- - -.. automodule:: intranet.middleware.templates - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.threadlocals module ---------------------------------------- - -.. automodule:: intranet.middleware.threadlocals - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.traceback module ------------------------------------- - -.. automodule:: intranet.middleware.traceback - :members: - :undoc-members: - :show-inheritance: - -intranet.middleware.url\_slashes module ---------------------------------------- - -.. automodule:: intranet.middleware.url_slashes - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.middleware - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.rst b/docs/sourcedoc/intranet.rst deleted file mode 100644 index 671f4081921..00000000000 --- a/docs/sourcedoc/intranet.rst +++ /dev/null @@ -1,57 +0,0 @@ -intranet package -================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - intranet.apps - intranet.middleware - intranet.settings - intranet.test - intranet.utils - -Submodules ----------- - -intranet.asgi module --------------------- - -.. automodule:: intranet.asgi - :members: - :undoc-members: - :show-inheritance: - -intranet.celery module ----------------------- - -.. automodule:: intranet.celery - :members: - :undoc-members: - :show-inheritance: - -intranet.routing module ------------------------ - -.. automodule:: intranet.routing - :members: - :undoc-members: - :show-inheritance: - -intranet.wsgi module --------------------- - -.. automodule:: intranet.wsgi - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.settings.rst b/docs/sourcedoc/intranet.settings.rst deleted file mode 100644 index a5eaa0add53..00000000000 --- a/docs/sourcedoc/intranet.settings.rst +++ /dev/null @@ -1,21 +0,0 @@ -intranet.settings package -========================= - -Submodules ----------- - -intranet.settings.ci\_secret module ------------------------------------ - -.. automodule:: intranet.settings.ci_secret - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.settings - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.test.rst b/docs/sourcedoc/intranet.test.rst deleted file mode 100644 index 084e3ba43aa..00000000000 --- a/docs/sourcedoc/intranet.test.rst +++ /dev/null @@ -1,29 +0,0 @@ -intranet.test package -===================== - -Submodules ----------- - -intranet.test.ion\_test module ------------------------------- - -.. automodule:: intranet.test.ion_test - :members: - :undoc-members: - :show-inheritance: - -intranet.test.test\_suite module --------------------------------- - -.. automodule:: intranet.test.test_suite - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.test - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/intranet.utils.rst b/docs/sourcedoc/intranet.utils.rst deleted file mode 100644 index d8788cb4f3c..00000000000 --- a/docs/sourcedoc/intranet.utils.rst +++ /dev/null @@ -1,85 +0,0 @@ -intranet.utils package -====================== - -Submodules ----------- - -intranet.utils.admin\_helpers module ------------------------------------- - -.. automodule:: intranet.utils.admin_helpers - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.cache module ---------------------------- - -.. automodule:: intranet.utils.cache - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.date module --------------------------- - -.. automodule:: intranet.utils.date - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.deletion module ------------------------------- - -.. automodule:: intranet.utils.deletion - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.helpers module ------------------------------ - -.. automodule:: intranet.utils.helpers - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.html module --------------------------- - -.. automodule:: intranet.utils.html - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.locking module ------------------------------ - -.. automodule:: intranet.utils.locking - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.serialization module ------------------------------------ - -.. automodule:: intranet.utils.serialization - :members: - :undoc-members: - :show-inheritance: - -intranet.utils.session module ------------------------------ - -.. automodule:: intranet.utils.session - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: intranet.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sourcedoc/modules.rst b/docs/sourcedoc/modules.rst deleted file mode 100644 index 9df35f534b0..00000000000 --- a/docs/sourcedoc/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -intranet -======== - -.. toctree:: - :maxdepth: 4 - - intranet diff --git a/intranet/apps/cslapps/models.py b/intranet/apps/cslapps/models.py index 4f3ea8d922c..1d4241b7f33 100644 --- a/intranet/apps/cslapps/models.py +++ b/intranet/apps/cslapps/models.py @@ -14,22 +14,7 @@ def visible_to_user(self, user): class App(models.Model): - """ - Represents an app maintained by the CSL. - Attributes: - name (str): The name of the app. - description (str): A description of the app. - order (int): The order in which the app should be displayed. - oauth_application (:obj:`CSLApplication`): The OAuth application associated with the app, if any. - auth_url (str): The URL to the app's authentication page (preferably, if available, using Ion OAuth). - url (str): The URL to the app. - image_url (str): The URL to the image icon for the app. - html_icon (str): HTML for the icon of the app, can be used for things like font awesome icons. - WARNING: this is rendered as safe. Do not allow untrusted content here. - invert_image_color_for_dark_mode (bool): Whether or not to invert the image color for dark mode. - Set to true if the image is a mostly dark color, which will require it to be inverted to appear on dark mode. - groups_visible (:obj:`list` of :obj:`Group`): Groups that can access this app. - """ + """Represents an app maintained by TJ CSL.""" objects = AppManager() diff --git a/intranet/apps/dashboard/views.py b/intranet/apps/dashboard/views.py index b2400653b8f..237537b26bd 100644 --- a/intranet/apps/dashboard/views.py +++ b/intranet/apps/dashboard/views.py @@ -196,6 +196,7 @@ def get_prerender_url(request): def get_announcements_list(request, context): """ An announcement will be shown if: + * It is not expired * unless ?show_expired=1 @@ -211,6 +212,7 @@ def get_announcements_list(request, context): * ...unless ?show_all=1 An event will be shown if: + * It is not expired * unless ?show_expired=1 @@ -265,10 +267,7 @@ def announcements_sorting_key(item): def paginate_announcements_list(request, context, items): - """ - Paginate ``items`` in groups of 15 - - """ + """Paginate ``items`` in groups of 15""" DEFAULT_PAGE_NUM = 1 if request.GET.get("page", "INVALID").isdigit(): @@ -304,6 +303,7 @@ def get_tjstar_mapping(user): def add_widgets_context(request, context): """ WIDGETS: + * Eighth signup (STUDENT) * Eighth attendance (TEACHER or ADMIN) * Enrichment activities (ALL if enrichment activity today) diff --git a/scripts/build_docs.py b/scripts/build_docs.py new file mode 100755 index 00000000000..06da7cda668 --- /dev/null +++ b/scripts/build_docs.py @@ -0,0 +1,107 @@ +#!/bin/env python3 + +from __future__ import annotations + +from collections.abc import Iterable +from pathlib import Path + +ION_ROOT = Path(__file__).parent.parent + +INTRANET = ION_ROOT / "intranet" +APPS = INTRANET / "apps" +MIDDLEWARE = INTRANET / "middleware" + +DOCS = ION_ROOT / "docs" / "source" +REF_INDEX = DOCS / "reference_index" +APPS_REF_INDEX = REF_INDEX / "apps" +MIDDLEWARE_REF = REF_INDEX / "middleware.rst" + +INDENT = " " + +IGNORE = ( + "__init__.py", + "__pycache__", + "migrations", +) + +def get_base_format_apps(name: str): + h1 = "#" * len(name) + return f""" +{h1} +{name} +{h1} + +.. currentmodule:: intranet.apps.{name} + +.. autosummary:: +{INDENT}:toctree: ../../reference + +""".lstrip() + +def get_base_format_middleware(name: str): + h1 = "#" * len(name) + return f""" +{h1} +{name} +{h1} + +.. currentmodule:: intranet.middleware + +.. autosummary:: +{INDENT}:toctree: ../reference + +""".lstrip() + + +def recursively_get_appfiles(path: Path) -> Iterable[Path]: + for app in path.iterdir(): + if app.is_dir() and app.name not in IGNORE: + yield from recursively_get_appfiles(app) + yield app + +def write_apps(): + for path in APPS.iterdir(): + appname = path.name + if appname in IGNORE or not path.is_dir(): + continue + s = get_base_format_apps(appname) + changed = False + for file in recursively_get_appfiles(path): + if file.name in IGNORE or file.suffix != ".py": + continue + formatted = str(file.relative_to(path).with_suffix('')).replace('/', '.') + s += f"{INDENT}{formatted}\n" + changed = True + + # don't write empty stuff + if not changed: + continue + + path = APPS_REF_INDEX / f"{appname}.rst" + path.write_text(s) + + print(f'{path.with_suffix("").name}/') + +def write_middleware(): + s = get_base_format_middleware("Middleware") + for path in MIDDLEWARE.iterdir(): + appname = path.name + if appname in IGNORE or path.suffix != ".py": + continue + s += f"{INDENT}~{path.relative_to(MIDDLEWARE).with_suffix('')}\n" + + print(appname) + + MIDDLEWARE_REF.write_text(s) + + +if __name__ == "__main__": + APPS_REF_INDEX.mkdir(parents=True, exist_ok=True) + + print(f"{'APPS':^20s}") + print(f"{''.ljust(20, '=')}\n") + write_apps() + + print(f"\n{'Middleware':^20s}") + print(f"{''.ljust(20, '=')}\n") + write_middleware() diff --git a/scripts/build_docs.sh b/scripts/build_docs.sh deleted file mode 100755 index b9f6c5141ea..00000000000 --- a/scripts/build_docs.sh +++ /dev/null @@ -1,6 +0,0 @@ -set -e -echo "Building docs..." -excludes="intranet/settings/secret.py intranet/urls.py intranet/apps/*/migrations" -sphinx-apidoc -f -o build/.tmp intranet $excludes -rsync --checksum build/.tmp/*.rst docs/sourcedoc/ -sphinx-build -WT -j auto docs -d build/sphinx/doctrees build/sphinx/html diff --git a/scripts/build_sources.sh b/scripts/build_sources.sh deleted file mode 100755 index 09674a87a0f..00000000000 --- a/scripts/build_sources.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/bash - -# This script is now obsolete due to the use of pyproject.toml. It is kept for future reference. -cd "$(dirname -- "$(readlink -f -- "$0")")/.." -./setup.py egg_info diff --git a/scripts/check.sh b/scripts/check.sh deleted file mode 100755 index 1f03088911e..00000000000 --- a/scripts/check.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/bin/bash -# Convenience script that runs format and lint scripts. - -set -e - -echo "Formatting..." -./scripts/format.sh -./scripts/static_templates_format.sh -echo - -echo "Validating commit messages..." -./scripts/validate-commit-messages.py $(git rev-parse HEAD~1) -echo - -if [ "$1" = "--lint" ]; then - echo "Linting..." - ./scripts/lint.sh - echo -fi - -echo "Done!" \ No newline at end of file diff --git a/scripts/format.sh b/scripts/format.sh deleted file mode 100755 index 9cb5206a8bd..00000000000 --- a/scripts/format.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash -cd "$(dirname -- "$(dirname -- "$(readlink -f "$0")")")" - -black . && autopep8 --in-place --recursive -j -1 . && isort -j 4 . diff --git a/scripts/lint.sh b/scripts/lint.sh deleted file mode 100755 index e793607225b..00000000000 --- a/scripts/lint.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash - -flake8 --max-line-length 150 --exclude=*/migrations/* intranet/ scripts/ docs/ *.py -pylint --jobs=8 --disable=fixme,broad-exception-caught,broad-exception-raised,unsupported-binary-operation,global-statement,attribute-defined-outside-init,cyclic-import,consider-using-f-string --django-settings-module=intranet.settings intranet/ diff --git a/scripts/push_docs.sh b/scripts/push_docs.sh index b6f5ff654a4..90c9894ca94 100755 --- a/scripts/push_docs.sh +++ b/scripts/push_docs.sh @@ -9,7 +9,7 @@ git config --global user.name "GitHub Actions" git clone --depth=50 --branch=gh-pages "https://${GH_TOKEN}@github.com/tjcsl/ion.git" gh-pages rm -rf gh-pages/* cd gh-pages -cp -R ../build/sphinx/html/* . +cp -R ../docs/build/sphinx/html/* . git add -A . latest=$(git log -1 --pretty=%s|sed "s/GitHub Actions build \([0-9]\+\)/\1/") git commit -m "GitHub Actions build $GITHUB_RUN_NUMBER" diff --git a/scripts/static_templates_format.sh b/scripts/static_templates_format.sh deleted file mode 100755 index b4303594d92..00000000000 --- a/scripts/static_templates_format.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -cd "$(dirname -- "$(dirname -- "$(readlink -f -- "$0")")")" - -# Remove trailing whitespace for all JS/CSS/SCSS/txt/JSON/SVG static files -find intranet/static -name vendor -prune -o -type f '(' -name '*.js' -o -name '*.css' -o -name '*.scss' -o -name '*.txt' -o -name '*.json' -o -name '*.svg' ')' -exec sed -i 's/\s\+$//' '{}' ';' -# Remove trailing whitespace for all templates -find intranet/templates -type f -exec sed -i 's/\s\+$//' '{}' ';'