.asciidoctorconfig

:docinfodir: {asciidoctorconfigdir}/.asciidoctor
:docinfo: shared

:!example-caption:
:icons: font
:experimental:

:project-root: {asciidoctorconfigdir}

:_url-wikipedia: https://wikipedia.org/wiki
:_url-jetbrains: https://jetbrains.com
:_url-jetbrains-wiki: {_url-jetbrains}/help
:_url-github: https://github.com
:_url-allauth-wiki: https://docs.allauth.org/en/latest
:_url-real-python-wiki: https://realpython.com
:_url-python-wiki: https://docs.python.org/3/library
:_url-python-peps: https://peps.python.org
:_url-geeks-for-geeks: https://geeksforgeeks.org
:_url-w3schools: https://w3schools.com
:_url-codecademy: https://codecademy.com

:url-uob-cs-gitlab: https://git.cs.bham.ac.uk
:url-uob-cs-gitlab-account: {url-uob-cs-gitlab}/-/profile
:url-uob-cs-gitlab-access-tokens: {url-uob-cs-gitlab}/-/user_settings/personal_access_tokens
:url-htmx-home: https://htmx.org
:url-htmx: {url-htmx-home}
:url-htmx-wiki: {url-htmx-home}/docs
:url-htmx-wiki-ajax: {url-htmx-wiki}#ajax
:url-htmx-wiki-swapping: {url-htmx-wiki}#swapping
:url-django-home: https://djangoproject.com
:url-django: {url-django-home}
:url-django-wiki: https://docs.djangoproject.com/en/4.2
:url-django-wiki-manage-commands: {url-django-wiki}/ref/django-admin
:url-django-wiki-development-server: {url-django-wiki}/intro/tutorial01#the-development-server
:url-django-wiki-settings: {url-django-wiki}/ref/settings
:url-django-wiki-settings-secret-key: {url-django-wiki-settings}#secret-key
:url-django-wiki-settings-databases: {url-django-wiki}/topics/migrations
:url-django-wiki-settings-debug: {url-django-wiki-settings}#debug
:url-django-wiki-settings-emails: {url-django-wiki-emails}#smtp-backend
:url-django-wiki-emails: {url-django-wiki}/topics/email
:url-django-wiki-projects-and-apps: {url-django-wiki}/ref/applications#projects-and-applications
:url-django-wiki-apps-configurations: {url-django-wiki}/ref/applications#application-configuration
:url-django-wiki-web-requests: {url-django-wiki}/topics/http
:url-django-wiki-urls: {url-django-wiki}/topics/http/urls
:url-django-wiki-urls-urlpatterns: {url-django-wiki-urls}#syntax-of-the-urlpatterns-variable
:url-django-wiki-urls-path: {url-django-wiki}/ref/urls#django.urls.path
:url-django-wiki-urls-reverse: {url-django-wiki}/ref/urlresolvers#reverse
:url-django-wiki-urls-naming: {url-django-wiki-urls}#naming-url-patterns
:url-django-wiki-lazy-loading: {url-django-wiki}/topics/performance/#understanding-laziness
:url-django-wiki-translatable-string: {url-django-wiki}/topics/i18n/translation#lazy-translations
:url-django-wiki-views: {url-django-wiki}/topics/http/views
:url-django-wiki-views-class-based: {url-django-wiki}/topics/class-based-views
:url-django-wiki-views-adding-context-data: {url-django-wiki-views-class-based}/generic-display#adding-extra-context
:url-django-wiki-views-template-response: {url-django-wiki-views-class-based}/base#django.views.generic.base.View
:url-django-wiki-views-base-view: {url-django-wiki}/ref/template-response
:url-django-wiki-models: {url-django-wiki}/topics/db/models
:url-django-wiki-models-migrations: {url-django-wiki}/topics/migrations
:url-django-wiki-models-queries: {url-django-wiki}/topics/db/queries
:url-django-wiki-models-managers: {url-django-wiki}/topics/db/managers
:url-django-wiki-models-inheritance: {url-django-wiki-models}#model-inheritance
:url-django-wiki-models-clean: {url-django-wiki-models}/instances#django.db.models.Model.clean
:url-django-wiki-models-save: {url-django-wiki-models}/instances#django.db.models.Model.save
:url-django-wiki-models-overriding-methods: {url-django-wiki-models}#overriding-model-methods
:url-django-wiki-models-verbose-name: {url-django-wiki}/ref/models/options#verbose-name
:url-django-wiki-models-meta: {url-django-wiki-models}#meta-options
:url-django-wiki-models-fields: {url-django-wiki}/ref/models/fields
:url-django-wiki-models-fields-verbose-name: {url-django-wiki-models-fields}#verbose-name
:url-django-wiki-models-fields-choices: {url-django-wiki-models-fields}#django.db.models.Field.choices
:url-django-wiki-admin-site: {url-django-wiki}/ref/contrib/admin
:url-django-wiki-admin-site-modeladmin: {url-django-wiki-admin-site}#modeladmin-objects
:url-django-wiki-admin-site-display-decorator: {url-django-wiki-admin-site}#the-display-decorator
:url-django-wiki-testing: {url-django-wiki}/topics/testing
:url-django-wiki-templates: {url-django-wiki}/topics/templates
:url-django-wiki-templates-inheritance: {url-django-wiki}/ref/language#template-inheritance
:url-django-wiki-templates-tags: {url-django-wiki-templates}#tags
:url-django-wiki-templates-tags-extends: {url-django-wiki}/ref/templates/builtins#extends
:url-django-wiki-templates-tags-static: {url-django-wiki}/ref/templates/builtins#static
:url-django-wiki-templates-tags-load: {url-django-wiki}/ref/templates/builtins#load
:url-django-wiki-static-files: {url-django-wiki}/howto/static-files
:url-djecrety: https://djecrety.ir
:url-allauth-home: https://allauth.org
:url-allauth: {url-allauth-home}
:url-allauth-social-providers: {_url-allauth-wiki}/socialaccount/providers
:url-allauth-email-verification: {_url-allauth-wiki}/account/views.html#email-verification
:url-python-home: https://python.org
:url-python: {url-python-home}
:url-python-312: {url-python-home}/downloads/release/python-3122
:url-python-312-windows-installer: {url-python-home}/ftp/python/3.12.2/python-3.12.2-amd64.exe
:url-python-wiki-pep8: {_url-python-peps}/pep-0008
:url-python-wiki-pep350-mnemonics: {_url-python-peps}/pep-0350#mnemonics
:url-python-wiki-pathlib: {_url-python-wiki}/pathlib
:url-python-wiki-iterable: {_url-python-wiki}/collections.abc.html#collections.abc.Iterable
:url-python-wiki-isinstance: {_url-python-wiki}/functions.html#isinstance
:url-python-wiki-hasattr: {_url-python-wiki}/functions.html#hasattr
:url-project-repo: {url-uob-cs-gitlab}/team-projects-2023-24/team55
:url-project-main-branch: {url-project-repo}/-/commits/main
:url-wiki-version-control-system: {_url-wikipedia}/Version_control
:url-wiki-line-separators: {_url-wikipedia}/Newline#Representation
:url-wiki-microsoft-windows: {_url-wikipedia}/Microsoft_Windows
:url-wiki-linux: {_url-wikipedia}/Linux
:url-wiki-linux-distribution: {_url-wikipedia}/Linux_distribution
:url-wiki-python-virtual-environment: {_url-real-python-wiki}/python-virtual-environments-a-primer#what-is-a-python-virtual-environment
:url-wiki-python-all-declaration: {_url-geeks-for-geeks}/python-__all__
:url-wiki-python-imports: {_url-real-python-wiki}/python-import
:url-wiki-python-immutable-constant-variables: {_url-real-python-wiki}/python-constants#type-annotating-constants
:url-wiki-python-f-strings: {_url-real-python-wiki}/python-f-strings
:url-wiki-python-is-vs-equals: {_url-real-python-wiki}/courses/python-is-identity-vs-equality
:url-wiki-python-exceptions: {_url-real-python-wiki}/courses/python-is-identity-vs-equality
:url-wiki-python-type-annotations: {_url-real-python-wiki}/python-type-checking#annotations
:url-wiki-python-collection-types: {_url-real-python-wiki}/python-collections-module
:url-wiki-python-lists: {_url-real-python-wiki}/python-list
:url-wiki-python-tuples: {_url-real-python-wiki}/python-tuple
:url-wiki-python-inheritance: {_url-real-python-wiki}/inheritance-composition-python
:url-wiki-python-docstrings: {_url-real-python-wiki}/documenting-python-code#documenting-your-python-code-base-using-docstrings
:url-wiki-python-keyword-arguments: {_url-w3schools}/python/gloss_python_function_keyword_arguments.asp
:url-wiki-python-positional-arguments: {_url-geeks-for-geeks}/keyword-and-positional-argument-in-python
:url-wiki-python-lambda-functions: {_url-real-python-wiki}/python-lambda#python-lambda-and-regular-functions
:url-wiki-python-comprehensions: {_url-geeks-for-geeks}/comprehensions-in-python
:url-wiki-python-method-overriding: {_url-geeks-for-geeks}/method-overriding-in-python
:url-wiki-python-super: {_url-real-python-wiki}/python-super
:url-wiki-python-property-decorator: {_url-real-python-wiki}/python-property
:url-wiki-python-raw-strings: {_url-real-python-wiki}/python-raw-strings
:url-wiki-python-class-attributes: {_url-real-python-wiki}/python-classes#class-attributes
:url-wiki-development: {_url-codecademy}/article/environments#heading-local-development-environment
:url-wiki-web-page: {_url-wikipedia}/Web_page
:url-wiki-environment-variables: {_url-wikipedia}/Environment_variable
:url-wiki-application-secrets: https://delinea.com/what-is/application-secrets
:url-wiki-env-files: https://blog.bitsrc.io/a-gentle-introduction-to-env-files-9ad424cc5ff4
:url-wiki-terminal: {_url-wikipedia}/Terminal_emulator
:url-wiki-terminal-command: {_url-wikipedia}/Command-line_interface#Anatomy_of_a_shell_CLI
:url-wiki-url: {_url-wikipedia}/URL
:url-wiki-crud: {_url-codecademy}/article/what-is-crud
:url-wiki-ajax: {_url-wikipedia}/Ajax_(programming)
:url-wiki-rest: {_url-wikipedia}/REST
:url-wiki-json: https://json.org
:url-wiki-api: {_url-wikipedia}/API
:url-wiki-open-api: {_url-wikipedia}/Open_API
:url-wiki-unit-tests: {_url-wikipedia}/Unit_testing
:url-wiki-html: {_url-wikipedia}/HTML
:url-wiki-css: {_url-wikipedia}/CSS
:url-wiki-javascript: {_url-wikipedia}/JavaScript
:url-wiki-linting: {_url-wikipedia}/Lint_(software)
:url-wiki-image: {_url-wikipedia}/Digital_image
:url-wiki-favicon: {_url-wikipedia}/Favicon
:url-wiki-programming-syntax: {_url-wikipedia}/Syntax_(programming_languages)
:url-wiki-programming-semantics: {_url-wikipedia}/Programming_language#Semantics
:url-wiki-regex: {_url-wikipedia}/Regular_expression
:url-wiki-duck-typing: {_url-wikipedia}/Duck_typing
:url-wiki-static-type-checking: {_url-wikipedia}/Type_system#Static_type_checking
:url-wiki-static-web-files: https://mattlayman.com/understand-django/serving-static-files#what-are-static-files
:url-wiki-subdirectory: https://merriam-webster.com/dictionary/subdirectory
:url-git-home: https://git-scm.com
:url-git: {url-git-home}
:url-git-wiki-push: {url-git-home}/docs/git-push
:url-git-wiki-repository: https://phoenixnap.com/kb/what-is-a-git-repository#ftoc-heading-1
:url-docker-home: https://docker.com
:url-docker: {url-docker-home}
:url-docker-engine: {url-docker-home}/products/container-runtime
:url-docker-wiki: https://docs.docker.com
:url-docker-wiki-scalability: {url-docker-wiki}/engine/swarm
:url-docker-wiki-best-practices: {url-docker-wiki}/resources/best-practices
:url-docker-wiki-security: {url-docker-wiki}/resources/security
:url-ruff-home: https://ruff.rs
:url-ruff: {url-ruff-home}
:url-ruff-wiki: https://docs.astral.sh/ruff
:url-ruff-wiki-import-sort: {url-ruff-wiki}/rules#isort-i
:url-ruff-wiki-quote-style: {url-ruff-wiki}/settings#format_quote-style
:url-ruff-wiki-line-length: {url-ruff-wiki}/settings#line-length
:url-ruff-wiki-rules-no-bare-except: {url-ruff-wiki}/rules/bare-except
:url-ruff-wiki-rules-mixed-spaces-and-tabs: {url-ruff-wiki}/rules/mixed-spaces-and-tabs
:url-ruff-wiki-rules-whitespace-after-bracket: {url-ruff-wiki}/rules/whitespace-after-open-bracket
:url-ruff-wiki-rules-whitespace-before-bracket: {url-ruff-wiki}/rules/whitespace-before-close-bracket
:url-ruff-wiki-rules-whitespace-around-parameter: {url-ruff-wiki}/rules/missing-whitespace-around-parameter-equals
:url-ruff-wiki-rules-whitespace-before-argument: {url-ruff-wiki}/rules/whitespace-before-parameters
:url-ruff-wiki-rules-whitespace-around-operator: {url-ruff-wiki}/rules/missing-whitespace-around-arithmetic-operator
:url-ruff-wiki-rules-trailing-whitespace: {url-ruff-wiki}/rules/trailing-whitespace
:url-ruff-wiki-rules-missing-newline-at-eof: {url-ruff-wiki}/rules/missing-newline-at-end-of-file
:url-ruff-wiki-rules-full-stop-ends-sentence: {url-ruff-wiki}/rules/ends-in-period
:url-ruff-wiki-rules-module-docstring: {url-ruff-wiki}/rules/undocumented-public-module
:url-djlint-home: https://djlint.com
:url-djlint: {url-djlint-home}
:url-mypy-home: https://mypy-lang.org
:url-mypy: {url-mypy-home}
:url-mypy-wiki: https://mypy.readthedocs.io/en/stable
:url-mypy-wiki-any-vs-object: {url-mypy-wiki}/dynamic_typing.html#any-vs-object
:url-mypy-wiki-override: https://typing.readthedocs.io/en/latest/spec/class-compat.html#override
:url-mypy-wiki-configuration: {url-mypy-wiki}/config_file.html
:url-rust-home: https://rust-lang.org
:url-rust: {url-rust-home}
:url-poetry-home: https://python-poetry.org
:url-poetry: {url-poetry-home}
:url-poetry-installation-instructions: {url-poetry-home}/docs#installing-with-the-official-installer
:url-poetry-managing-dependencies: {url-poetry-home}/docs/managing-dependencies
:url-poetry-wiki-pyproject: {url-poetry-home}/docs/pyproject
:url-pre-commit-home: https://pre-commit.com
:url-pre-commit: {url-pre-commit-home}
:url-pre-commit-available-checks: https://github.com/pre-commit/pre-commit-hooks#hooks-available
:url-pre-commit-pygrep: https://github.com/pre-commit/pygrep-hooks#provided-hooks
:url-asciidoc-home: https://asciidoc.org
:url-asciidoc: {url-asciidoc-home}
:url-asciidoc-validator: https://docs.asciidoctor.org/asciidoc/latest/macros/xref-validate
:url-asciidoc-asciidoctor: https://asciidoctor.org
:url-docbook-home: https://docbook.org
:url-docbook: {url-docbook-home}
:url-ubuntu-home: https://ubuntu.com
:url-ubuntu: {url-ubuntu-home}
:url-fedora-home: https://fedoraproject.org
:url-fedora: {url-fedora-home}
:url-fedora-python-312: https://packages.fedoraproject.org/pkgs/python3.12/python3.12
:url-redhat-home: https://redhat.com
:url-redhat: {url-redhat-home}
:url-rhel-home: {url-redhat-home}/technologies/linux-platforms/enterprise-linux
:url-rhel: {url-rhel-home}
:url-arch-home: https://archlinux.org
:url-arch-python-312: https://aur.archlinux.org/packages/python312
:url-arch: {url-arch-home}
:url-arch-aur: https://wiki.archlinux.org/title/AUR
:url-pycharm-home: {_url-jetbrains}/pycharm
:url-pycharm: {url-pycharm-home}
:url-pycharm-download: {url-pycharm-home}/download
:url-pycharm-django-support: {_url-jetbrains-wiki}/pycharm/django-support7.html#django-support
:url-pycharm-plugins: https://plugins.jetbrains.com/pycharm
:url-pycharm-gitlab-plugin: https://plugins.jetbrains.com/plugin/22857-gitlab
:url-pycharm-asciidoc-plugin: https://plugins.jetbrains.com/plugin/7391-asciidoc
:url-pycharm-wiki-configuring-python-interpreter: {_url-jetbrains-wiki}/pycharm/configuring-python-interpreter.html
:url-pycharm-wiki-terminal-pane: {_url-jetbrains-wiki}/pycharm/terminal-emulator.html
:url-pycharm-wiki-run-configurations: {_url-jetbrains-wiki}/pycharm/run-debug-configuration.html
:url-pycharm-wiki-run-configurations-templates: {url-pycharm-wiki-run-configurations}#templates
:url-pycharm-wiki-run-django: {_url-jetbrains-wiki}/pycharm/run-debug-configuration-django-server.html
:url-pycharm-wiki-run-django-manage: {_url-jetbrains-wiki}/pycharm/running-manage-py.html#run
:url-pycharm-wiki-run-tool-window: {_url-jetbrains-wiki}/pycharm/run-tool-window.html
:url-pycharm-wiki-settings-popup: {_url-jetbrains-wiki}/pycharm/settings-preferences-dialog.html
:url-pycharm-wiki-settings-django: {_url-jetbrains-wiki}/pycharm/django-support.html
:url-pycharm-wiki-settings-django-enable: {url-pycharm-wiki-settings-django}#7b34b333_2
:url-pycharm-wiki-settings-project-structure: {_url-jetbrains-wiki}/pycharm/project-structure-dialog.html
:url-pycharm-wiki-settings-project-structure-marked-directories: {url-pycharm-wiki-settings-project-structure}#f0ded71f_3
:url-pycharm-wiki-settings-run-configurations: {_url-jetbrains-wiki}/pycharm/run-debug-configurations-dialog.html
:url-article-commit-message-guidelines: https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53
:url-article-install-python-from-deadsnakes-ppa: https://makeuseof.com/install-python-ubuntu#use-deadsnakes-ppa-to-install-python-3-12-on-ubuntu
:url-article-install-python-from-source: https://aruljohn.com/blog/install-python#download-python-3122-source
:url-article-dont-commit-application-secrets: https://littlemaninmyhead.wordpress.com/2021/04/05/why-we-shouldnt-commit-secrets-into-source-code-repositories
:url-github-student-dev-pack: https://education.github.com/pack
:url-github-account: {_url-github}/account
:url-jetbrains-account: https://account.jetbrains.com
:url-jetbrains-github-account-connection: {_url-jetbrains}/student?authMethod=github
:url-deadsnakes-python-ppa: https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa
:url-deadsnakes-python-ppa-packages: {url-deadsnakes-python-ppa}/+packages
:url-deadsnakes-python-ppa-312: {url-deadsnakes-python-ppa}/+packages#pub15817942

:labelled-url-uob-cs-gitlab-account: {url-uob-cs-gitlab-account}[UoB CS GitLab Account]
:labelled-url-htmx: {url-htmx}[HTMX]
:labelled-url-django: {url-django}[Django]
:labelled-url-python: {url-python}[Python]
:labelled-url-python-312: {url-python-312}[Python 3.12]
:labelled-url-wiki-microsoft-windows: {url-wiki-microsoft-windows}[Windows]
:labelled-url-wiki-linux: {url-wiki-linux}[Linux]
:labelled-url-wiki-url: {url-wiki-url}[URL]
:labelled-url-wiki-rest: {url-wiki-rest}[REST]
:labelled-url-wiki-crud: {url-wiki-crud}[CRUD]
:labelled-url-wiki-api: {url-wiki-api}[API]
:labelled-url-wiki-json: {url-wiki-json}[JSON]
:labelled-url-wiki-ajax: {url-wiki-ajax}[Ajax]
:labelled-url-wiki-html: {url-wiki-html}[HTML]
:labelled-url-wiki-css: {url-wiki-css}[CSS]
:labelled-url-wiki-js: {url-wiki-css}[JS]
:labelled-url-wiki-pascal-case: {_url-wikipedia}/Camel_case#Variations_and_synonyms[PascalCase]
:labelled-url-wiki-snake-case: {_url-wikipedia}/Snake_case[snake_case,role=no-link-underline]
:labelled-url-wiki-all-caps-case: {_url-wikipedia}/All_caps#Computing[ALL_CAPS_CASE,role=no-link-underline]
:labelled-url-git: {url-git}[Git]
:labelled-url-ruff: {url-ruff}[Ruff]
:labelled-url-djlint: {url-djlint}[djLint]
:labelled-url-mypy: {url-mypy}[Mypy]
:labelled-url-rust: {url-rust}[Rust]
:labelled-url-poetry: {url-poetry}[Poetry]
:labelled-url-pre-commit: {url-pre-commit}[pre-commit]
:labelled-url-asciidoc: {url-asciidoc}[AsciiDoc]
:labelled-url-asciidoc-asciidoctor: {url-asciidoc-asciidoctor}[Asciidoctor]
:labelled-url-docbook: {url-docbook}[DocBook]
:labelled-url-ubuntu: {url-ubuntu}[Ubuntu]
:labelled-url-fedora: {url-fedora}[Fedora]
:labelled-url-redhat: {url-redhat}[RedHat]
:labelled-url-rhel: {url-rhel}[RHEL]
:labelled-url-arch: {url-arch}[Arch Linux]
:labelled-url-arch-aur: {url-arch-aur}[AUR]
:labelled-url-pycharm: {url-pycharm}[PyCharm]
:labelled-url-pycharm-professional: {url-pycharm}[PyCharm Professional]
:labelled-url-pycharm-ide: {url-pycharm}[PyCharm Professional IDE]
:labelled-url-github-student-dev-pack: {url-github-student-dev-pack}[GitHub's Student Developer Pack]