diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 000000000..b07fdd056 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 327b25503f346a013b7e440698876136 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/advanced_csv_import.doctree b/.doctrees/advanced_csv_import.doctree new file mode 100644 index 000000000..44a6ca6bf Binary files /dev/null and b/.doctrees/advanced_csv_import.doctree differ diff --git a/.doctrees/area_coordinator.doctree b/.doctrees/area_coordinator.doctree new file mode 100644 index 000000000..354f0d11f Binary files /dev/null and b/.doctrees/area_coordinator.doctree differ diff --git a/.doctrees/bulk_upload.doctree b/.doctrees/bulk_upload.doctree new file mode 100644 index 000000000..9142b9b82 Binary files /dev/null and b/.doctrees/bulk_upload.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 000000000..4072e3e34 Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 000000000..f82526fcc Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/_sources/advanced_csv_import.md.txt b/_sources/advanced_csv_import.md.txt new file mode 100644 index 000000000..589ebfac3 --- /dev/null +++ b/_sources/advanced_csv_import.md.txt @@ -0,0 +1,206 @@ +Advanced csv import +============================================= +This is the documentation of the advanced csv import command `advanced_csv_import`. For the documentation of the less complicated +bulk-upload command `bulk-add-officers` see [`bulk_upload`](bulk_upload.md). `bulk-add-officers` accepts one csv containing information +about the officer, including badge-number, jobs and salary and makes decisions on whether to update rows in the database +or create new entries based on the existing data. + +The advanced csv upload is for the most part a way to copy data for one department into the database with as little as possible logic added on. +So the tables provided in csv form represent the data that will be inside the sql tables after running the command. +(With a few exceptions for many-to-many relationships and auxiliary models like location and license plates) + +Before you start +---------------- +CSV uploads should always be tested locally or in other non-production environments, and it is strongly recommended +to have the database backed up before running the command. The command is designed to fail early and will +only commit the changes if it didn't encounter any problems. The command however is pretty powerful +and can therefore lead to data loss and inconsistencies if the provided csv files are not prepared correctly. + +Explanation of the command +-------------------------- +```shell + /usr/src/app/OpenOversight$ flask advanced-csv-import --help + Usage: flask advanced-csv-import [OPTIONS] DEPARTMENT_NAME DEPARTMENT_STATE + + Add or update officers, assignments, salaries, links and incidents from + csv files in the department using the DEPARTMENT_NAME and DEPARTMENT_STATE. + + The csv files are treated as the source of truth. Existing entries might + be overwritten as a result, backing up the database and running the + command locally first is highly recommended. + + See the documentation before running the command. + + Options: + --officers-csv PATH + --assignments-csv PATH + --salaries-csv PATH + --links-csv PATH + --incidents-csv PATH + --force-create Only for development/testing! + --overwrite-assignments + --help Show this message and exit. +``` + + +The command expects two mandatory arguments, the department name and department state. +This is to reduce the chance of making changes to the wrong department by mixing up files. +Then there are 5 options to include paths to officers, assignments, salaries, incidents and links csv files. +Then there is a `--force-create` flag that allows to delete and overwrite existing entries in the database. +This is only supposed to be used in non-production environments and to allow replication of the data of another (in most cases production) +instance to local environments to test the import command locally first. More details on that flag at the end of the document: :ref:`ref-aci-force-create`. +Finally, there is `--overwrite-assignments` which simplifies updating assignments. Instead of updating them, +all assignments for the relevant officers are deleted and created new based on the provided data. This flag is only +considered if an assignments-csv is provided and ignored otherwise. See the instructions in +the section on assignment-csv for more details. + +General overview of the csv import +----------------------------------- +The following lists the header fields that each csv can contain. If the csv includes any other fields, the command will fail. +However, the fields are not case-sensitive and spaces are treated as `_`. So `Officer ID` can be used instead of `officer_id`. + +*All optional fields can be left blank and will be inserted as* `NULL` *or empty string as appropriate.* +**Warning:** When updating a record a field that is left blank might overwrite an existing record. +This can only be prevented by not including the column in the csv at all. + +.. _ref-aci-formats: + +Formats: +- `date` - The date should be provided in `YYYY-MM-DD` format. +- `time` - Time should be provided in `HH:MM:SS` 24h-format in the respective timezone. +- `DEPARTMENT_STATE` - The department state should be provided in the `standard two-letter abbreviation `_ format. + + +The `id` field +-------------- +Each csv corresponds to a table in the OpenOversight database. And each csv file has to include `id` as a field in the table. +That field has one primary purpose: If the field is blank, it is assumed that that row is a new entry. +If the field contains a number however, it is assumed that a record with that particular id already exists in the database +and the record will be updated according to the provided fields. Finally, in the case of officers and incidents +there is a third option where the `id` field can contain a string that starts with `#`. This also indicates a new record, +but that new record can be referenced in other provided tables. (for example as the `officer_id` in the salaries csv) + + + +Officers csv +------------ +- Required: `id, department_name, department_state` +- Optional: `last_name, first_name, middle_initial, suffix, race, gender, employment_date, birth_year, unique_internal_identifier` +- Ignored: `badge_number, job_title, most_recent_salary, unique_identifier` (Unused but command will not fail when field is present) + +Details +-------- +- `department_name` - Name of department exactly as it is in the server database. + This needs to match the department name provided with the command. +- `department_state` - Name of department state exactly as it is in the server database, which will be the + [standard two-letter abbreviation](https://www.faa.gov/air_traffic/publications/atpubs/cnt_html/appendix_a.html) for the department's respective location. + This needs to match the department state provided with the command. +- `unique_internal_identifier` - A string or number that can be used to + uniquely identify the officer, in departments in which the badge + number stays with the officer using that number is fine. Can and should be left blank + if no such number is available. +- `first_name` & `last_name` Will be inserted into the database as is. +- `middle_initial` - Usually up to one character, but can be more. +- `suffix` - Choice of the following values: `Jr, Sr, II, III, IV, V`. +- `gender` - One of the following values: `M`, `F`, `Other`. +- `race` - One of the following values: `BLACK`, `WHITE`, `ASIAN`, `HISPANIC`, `NATIVE AMERICAN`, `PACIFIC ISLANDER`, `Other`. +- `employment_date` - [Date](https://help.highbond.com/helpdocs/analytics/13/user-guide/en-us/Content/table_definition/c_formats_of_date_and_time_source_data.htm) representing the start of employment with this department. +- `birth_year` - Integer representing the birth year of the officer in a `yyyy` format. + +Assignments csv +--------------- +- Required: `id, officer_id, job_title` +- Optional: `badge_number, unit_id, unit_name, start_date, resign_date` + +Details +-------- +- `officer_id` - Number referring to `id` of existing officer or string starting with `#` referring to a newly created officer in the provided officers csv. +- `badge_number` - Any string that represents the star or badge number of the officer. In some departments this number changes with the assignment. +- `job_title` - The job title, will be created if it does not exist. +- `unit_id` - ID of existing unit within the department. +- `unit_name` - Name of the unit, only used if the `unit_id` column is not provided. +- `start_date` - [Start date](https://help.highbond.com/helpdocs/analytics/13/user-guide/en-us/Content/table_definition/c_formats_of_date_and_time_source_data.htm) of this assignment. +- `resign_date` - [End date](https://help.highbond.com/helpdocs/analytics/13/user-guide/en-us/Content/table_definition/c_formats_of_date_and_time_source_data.htm) of this assignment. + +Special Flag +------------- +The `--overwrite-assignments` in the command can be used to not merge new with existing assignments. +Instead, all existing assignments belonging to officers named in the `officer_id` column are deleted first, +before the new assignments contained in the provided csv are created in the database. + +This should only be used if the provided csv contains both the currently in the database and additional assignments, +or is based on a better and more complete dataset, for example after receiving a dataset for historic assignment data. + +Salaries csv +------------ +- Required: `id, officer_id, salary, year` +- Optional: `overtime_pay, is_fiscal_year` + +Details +-------- +- `officer_id` - Integer referring to `id` of existing officer or string starting with `#` referring to a newly created officer in the provided officers csv. +- `salary` - Number representing the officer's salary in the given year. +- `year` - Integer, the year this salary information refers to. +- `overtime_pay` - Number representing the amount of overtime payment for offer in given year. +- `is_fiscal_year` - Boolean value, indicating whether the provided year refers to calendar year or fiscal year. + The values `true`, `t`, `yes` and `y` are treated as "yes, the salary is for the fiscal year", all others (including blank) as "no". + +Incidents csv +------------- +- Required: `id, department_name, department_state` +- Optional: `date, time, report_number, description, street_name, cross_street1, cross_street2, city, state, zip_code, + created_by, last_updated_by, officer_ids, license_plates` + +Details +-------- +- `department_name` - Name of department exactly as in the server database. + This needs to match the department name provided with the command. +- `department_state` - Name of department state exactly as it is in the server database, which will be the + `standard two-letter abbreviation `_ for the department's respective location. +- `date` - [Date](https://help.highbond.com/helpdocs/analytics/13/user-guide/en-us/Content/table_definition/c_formats_of_date_and_time_source_data.htm) of the incident +- `time` - [Time](https://help.highbond.com/helpdocs/analytics/13/user-guide/en-us/Content/table_definition/c_formats_of_date_and_time_source_data.htm) of the incident +- `report_number` - String representing any kind of number assigned to complaints or incidents by the police department. +- `description` - Text description of the incident. +- `street_name` - Name of the street the incident occurred, but should not include the street number. +- `cross_street1`, `cross_street2` The two closest intersecting streets. +- `city`, `state`, `zip_code` State needs to be in 2 letter abbreviated notation. +- `created_by`, `last_updated_by` - ID of existing user shown as responsible for adding this entry. +- `officer_ids` - IDs of officers involved in the incident, separated by `|`. + - Each individual id can either be an integer referring to an existing officer or a string starting with `#` referring to a newly created officer. + - Example: `123|#C1|1627` for three officers, one with id 123, one with 1627 and one whose record was created in the officers csv + and whose id-field was the string `#C1`. + +- `license_plates` - All license plates involved in the incident. If there is more than one, they can be separated with a `|`. + - Each license plate consists of the license plate number and optionally a state in abbreviated form separated by an underscore `_`. + - Example: `ABC123_IL|B991` for one license plate with number `ABC123` from Illinois and one with number `B991` and no associated state. + + +Links csv +--------- +- Required: `id, url` +- Optional: `title, link_type, description, author, created_by, officer_ids, incident_ids` + +Details +-------- +- `url` - Full url of the link starting with `http://` or `https://`. +- `title` - Text that will be displayed as the link. +- `description` - A short description of the link. +- `link_type` - Choice of `Link`, `YouTube Video` and `Other Video`. +- `author` - The source or author of the linked article, report, video. +- `created_by` - ID of existing user shown as responsible for adding this entry. +- `officer_ids` - IDs of officer profiles this link should be visible on, separated by `|`. See same field in incidents above for more details. +- `incidents_ids` - IDs of incidents this link should be associated with, separated by `|`. Just like `officer_ids` this can contain strings. + starting with `#` to refer to an incident created in the incident csv. + +Examples +--------- +Example csvs can be found in the repository under `OpenOversight/tests/test_csvs`. + +Local development flag `--force-create` +--------------------------------------- +This flag changes the behavior when an integer is provided as `id`. Instead of updating an existing record, +a new record will be created and assigned the given `id`. If a record with that `id` already exists in the +database, it will be deleted before the new record is created. + +This functionality is intended to be used to import csv files downloaded from `OpenOversight download page `_ +to get a local copy of the production data for one department in the local development database. diff --git a/_sources/area_coordinator.md.txt b/_sources/area_coordinator.md.txt new file mode 100644 index 000000000..58018a335 --- /dev/null +++ b/_sources/area_coordinator.md.txt @@ -0,0 +1,15 @@ +Area Coordinator +================ + +An area coordinator is a person with an account on +OpenOversight that is charged with curating the collection for a particular +department. There can be several area coordinators for a given department. +The tasks they perform include: + +* Add new officers +* Update officer information, such as new assignments or promotions +* Add private notes to particular officer profiles (visible to other area + coordinators or administrators) +* Add a brief description to an officer's profile +* Add links and videos to officer's profiles +* Add incidents linked to one or more officers diff --git a/_sources/bulk_upload.md.txt b/_sources/bulk_upload.md.txt new file mode 100644 index 000000000..f1e3bc8bc --- /dev/null +++ b/_sources/bulk_upload.md.txt @@ -0,0 +1,87 @@ +Using the bulk upload feature +============================= +To facilitate adding rosters of new departments or updating existing +departments there is a flask command that gives system administrators +the ability to load the data from a csv file directly into the database. + +**Warning** This process is not very robust at this point and there is +risk of leaving the database in an inconsistent state. It is strongly +recommended to back up the database before starting this operation and +to run the command on a development server first and see if the results +are as expected. + +Preparation steps +----------------- +- Create department if it does not exist +- Add ranks in hierarchical order, make sure all the ranks present in + the csv are added + +Layout of the csv file +---------------------- +The csv file can have the following fields: +``` + department_id + unique_internal_identifier + first_name + last_name + middle_initial + suffix + gender + race + employment_date + birth_year + star_no + job_title + unit_id + start_date + resign_date + salary + salary_year + salary_is_fiscal_year + overtime_pay +``` + + +Explanation of the individual fields +------------------------------------ +General information: +- `department_id` - ID of department in the server database, for example `1` for Chicago Police Department can be found in + url for that department: `https://openoversight.com/departments/1`. +- `unique_internal_identifier` - A string or number that can be used to uniquely identify the officer, in departments in + which the badge number stays with the officer using that number is fine, otherwise it is recommended to leave this + blank and provide the `star_no` instead. +- `first_name` & `last_name` & `middle_initial` +- `suffix` - One of the following values: `Jr, Sr, II, III, IV, V`. +- `gender` - One of the following values: `M`, `F`, `Other` or `Not Sure`. +- `race` - One of the following values: `BLACK`, `WHITE`, `ASIAN`, `HISPANIC`, `NATIVE AMERICAN`, `PACIFIC ISLANDER`, `Other`, `Not Sure`. +- `employment_date` - Start of employment with this department. +- `birth_year` - Integer representing the birth year of the officer in a `yyyy` format + +Current Employment information: +- `star_no` - Star or badge number, might be related to current rank. +- `job_title` - Rank or title, needs to be added to this department verbatim or `Not Sure`, +- `unit_id` - ID of unit within the department. +- `start_date` - Start date of this assignment. +- `resign_date` - Resignation date of this assignment. + +Salary information: +If adding salary data, the following fields are required: `salary_year`, +`salary_is_fiscal_year`, and `salary`. +- `salary_year` - Year of which the salary information is provided in a `yyyy` format. +- `salary_is_fiscal_year` - `true` or `false`, salary information is on fiscal year basis vs. calendar year. +- `salary` - Salary in given year. +- `overtime_pay` - Overtime received in given year. + +Required fields +- `department_id`, `first_name`, `last_name`, `job_title` and either `star_no` or `unique_internal_identifier` are required. +- `employment_date`, `start_date` and `resign_date` can be either in `yyyy-mm-dd` or `mm/dd/yyyy` format - if the column is present + the field cannot be left blank. + +Command-line options +- `--no-create` - For each line in the CSV, update an existing officer if one exists, but do not create any new officers. If an officer in the CSV is not already in OpenOversight, the line will be ignored. +- `--update-by-name` - Update officers by `first_name` and `last_name`. Useful when `unique_internal_identifier` and `star_no` are not available. +- `--update-static-fields` - Allow modifications to normally-static fields like `race`, `birth_year`, etc., which OpenOversight normally prevents from being modified. Values in the database will be overwritten with values in the CSV. + +The command to run on the server +-------------------------------- +`/usr/src/app/OpenOversight$ flask bulk-add-officers [/path/to/csv_file.csv]` diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 000000000..ce74ccc58 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,28 @@ +.. OpenOversight documentation master file, created by + sphinx-quickstart on Fri Jun 29 23:35:10 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to OpenOversight's documentation! +========================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + area_coordinator + bulk_upload + advanced_csv_import + +OpenOversight is a Lucy Parsons Labs project to improve law enforcement +accountability through public and crowdsourced data. We maintain a database +of officer demographic information and provide digital galleries of photographs. +This is done to help people identify law enforcement officers for filing +complaints and in order for the public to see work-related information about +law enforcement officers that interact with the public. + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/_static/alabaster.css b/_static/alabaster.css new file mode 100644 index 000000000..e3174bf93 --- /dev/null +++ b/_static/alabaster.css @@ -0,0 +1,708 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar { + max-height: 100%; + overflow-y: auto; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Hide ugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 000000000..e5179b7a9 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: inherit; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/custom.css b/_static/custom.css new file mode 100644 index 000000000..2a924f1d6 --- /dev/null +++ b/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 000000000..4d67807d1 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 000000000..7e4c114f2 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 000000000..a858a410e Binary files /dev/null and b/_static/file.png differ diff --git a/_static/language_data.js b/_static/language_data.js new file mode 100644 index 000000000..367b8ed81 --- /dev/null +++ b/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/lpl-logo.png b/_static/lpl-logo.png new file mode 100644 index 000000000..e0169599d Binary files /dev/null and b/_static/lpl-logo.png differ diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 000000000..d96755fda Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 000000000..7107cec93 Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 000000000..0d49244ed --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #333333 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #208050 } /* Literal.Number.Bin */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287e } /* Name.Function.Magic */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 000000000..92da3f8b2 --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,619 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlinks", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 000000000..8a96c69a1 --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/advanced_csv_import.html b/advanced_csv_import.html new file mode 100644 index 000000000..2bd9f4e77 --- /dev/null +++ b/advanced_csv_import.html @@ -0,0 +1,345 @@ + + + + + + + + Advanced csv import — OpenOversight documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Advanced csv import

+

This is the documentation of the advanced csv import command advanced_csv_import. For the documentation of the less complicated +bulk-upload command bulk-add-officers see bulk_upload. bulk-add-officers accepts one csv containing information +about the officer, including badge-number, jobs and salary and makes decisions on whether to update rows in the database +or create new entries based on the existing data.

+

The advanced csv upload is for the most part a way to copy data for one department into the database with as little as possible logic added on. +So the tables provided in csv form represent the data that will be inside the sql tables after running the command. +(With a few exceptions for many-to-many relationships and auxiliary models like location and license plates)

+
+

Before you start

+

CSV uploads should always be tested locally or in other non-production environments, and it is strongly recommended +to have the database backed up before running the command. The command is designed to fail early and will +only commit the changes if it didn’t encounter any problems. The command however is pretty powerful +and can therefore lead to data loss and inconsistencies if the provided csv files are not prepared correctly.

+
+
+

Explanation of the command

+
  /usr/src/app/OpenOversight$ flask advanced-csv-import --help
+  Usage: flask advanced-csv-import [OPTIONS] DEPARTMENT_NAME DEPARTMENT_STATE
+
+    Add or update officers, assignments, salaries, links and incidents from
+    csv files in the department using the DEPARTMENT_NAME and DEPARTMENT_STATE.
+
+    The csv files are treated as the source of truth. Existing entries might
+    be overwritten as a result, backing up the database and running the
+    command locally first is highly recommended.
+
+    See the documentation before running the command.
+
+  Options:
+    --officers-csv PATH
+    --assignments-csv PATH
+    --salaries-csv PATH
+    --links-csv PATH
+    --incidents-csv PATH
+    --force-create           Only for development/testing!
+    --overwrite-assignments
+    --help                   Show this message and exit.
+
+
+

The command expects two mandatory arguments, the department name and department state. +This is to reduce the chance of making changes to the wrong department by mixing up files. +Then there are 5 options to include paths to officers, assignments, salaries, incidents and links csv files. +Then there is a --force-create flag that allows to delete and overwrite existing entries in the database. +This is only supposed to be used in non-production environments and to allow replication of the data of another (in most cases production) +instance to local environments to test the import command locally first. More details on that flag at the end of the document: :ref:ref-aci-force-create. +Finally, there is --overwrite-assignments which simplifies updating assignments. Instead of updating them, +all assignments for the relevant officers are deleted and created new based on the provided data. This flag is only +considered if an assignments-csv is provided and ignored otherwise. See the instructions in +the section on assignment-csv for more details.

+
+
+

General overview of the csv import

+

The following lists the header fields that each csv can contain. If the csv includes any other fields, the command will fail. +However, the fields are not case-sensitive and spaces are treated as _. So Officer ID can be used instead of officer_id.

+

All optional fields can be left blank and will be inserted as NULL or empty string as appropriate. +Warning: When updating a record a field that is left blank might overwrite an existing record. +This can only be prevented by not including the column in the csv at all.

+

.. _ref-aci-formats:

+

Formats:

+
    +

  • date - The date should be provided in YYYY-MM-DD format.

    • +

  • time - Time should be provided in HH:MM:SS 24h-format in the respective timezone.

    • +

  • DEPARTMENT_STATE - The department state should be provided in the standard two-letter abbreviation <https://www.faa.gov/air_traffic/publications/atpubs/cnt_html/appendix_a.html>_ format.

    • +
+
+
+

The id field

+

Each csv corresponds to a table in the OpenOversight database. And each csv file has to include id as a field in the table. +That field has one primary purpose: If the field is blank, it is assumed that that row is a new entry. +If the field contains a number however, it is assumed that a record with that particular id already exists in the database +and the record will be updated according to the provided fields. Finally, in the case of officers and incidents +there is a third option where the id field can contain a string that starts with #. This also indicates a new record, +but that new record can be referenced in other provided tables. (for example as the officer_id in the salaries csv)

+
+
+

Officers csv

+
    +

  • Required: id, department_name, department_state

    • +

  • Optional: last_name, first_name, middle_initial, suffix, race, gender, employment_date, birth_year, unique_internal_identifier

    • +

  • Ignored: badge_number, job_title, most_recent_salary, unique_identifier (Unused but command will not fail when field is present)

    • +
+
+
+

Details

+
    +

  • department_name - Name of department exactly as it is in the server database. +This needs to match the department name provided with the command.

    • +

  • department_state - Name of department state exactly as it is in the server database, which will be the +standard two-letter abbreviation for the department’s respective location. +This needs to match the department state provided with the command.

    • +

  • unique_internal_identifier - A string or number that can be used to +uniquely identify the officer, in departments in which the badge +number stays with the officer using that number is fine. Can and should be left blank +if no such number is available.

    • +

  • first_name & last_name Will be inserted into the database as is.

    • +

  • middle_initial - Usually up to one character, but can be more.

    • +

  • suffix - Choice of the following values: Jr, Sr, II, III, IV, V.

    • +

  • gender - One of the following values: M, F, Other.

    • +

  • race - One of the following values: BLACK, WHITE, ASIAN, HISPANIC, NATIVE AMERICAN, PACIFIC ISLANDER, Other.

    • +

  • employment_date - Date representing the start of employment with this department.

    • +

  • birth_year - Integer representing the birth year of the officer in a yyyy format.

    • +
+
+
+

Assignments csv

+
    +

  • Required: id, officer_id, job_title

    • +

  • Optional: badge_number, unit_id, unit_name, start_date, resign_date

    • +
+
+
+

Details

+
    +

  • officer_id - Number referring to id of existing officer or string starting with # referring to a newly created officer in the provided officers csv.

    • +

  • badge_number - Any string that represents the star or badge number of the officer. In some departments this number changes with the assignment.

    • +

  • job_title - The job title, will be created if it does not exist.

    • +

  • unit_id - ID of existing unit within the department.

    • +

  • unit_name - Name of the unit, only used if the unit_id column is not provided.

    • +

  • start_date - Start date of this assignment.

    • +

  • resign_date - End date of this assignment.

    • +
+
+
+

Special Flag

+

The --overwrite-assignments in the command can be used to not merge new with existing assignments. +Instead, all existing assignments belonging to officers named in the officer_id column are deleted first, +before the new assignments contained in the provided csv are created in the database.

+

This should only be used if the provided csv contains both the currently in the database and additional assignments, +or is based on a better and more complete dataset, for example after receiving a dataset for historic assignment data.

+
+
+

Salaries csv

+
    +

  • Required: id, officer_id, salary, year

    • +

  • Optional: overtime_pay, is_fiscal_year

    • +
+
+
+

Details

+
    +

  • officer_id - Integer referring to id of existing officer or string starting with # referring to a newly created officer in the provided officers csv.

    • +

  • salary - Number representing the officer’s salary in the given year.

    • +

  • year - Integer, the year this salary information refers to.

    • +

  • overtime_pay - Number representing the amount of overtime payment for offer in given year.

    • +

  • is_fiscal_year - Boolean value, indicating whether the provided year refers to calendar year or fiscal year. +The values true, t, yes and y are treated as “yes, the salary is for the fiscal year”, all others (including blank) as “no”.

    • +
+
+
+

Incidents csv

+
    +

  • Required: id, department_name, department_state

    • +

  • Optional: date, time, report_number, description, street_name, cross_street1, cross_street2, city, state, zip_code, created_by, last_updated_by, officer_ids, license_plates

    • +
+
+
+

Details

+
    +

  • department_name - Name of department exactly as in the server database. +This needs to match the department name provided with the command.

    • +

  • department_state - Name of department state exactly as it is in the server database, which will be the +standard two-letter abbreviation <https://www.faa.gov/air_traffic/publications/atpubs/cnt_html/appendix_a.html>_ for the department’s respective location.

    • +

  • date - Date of the incident

    • +

  • time - Time of the incident

    • +

  • report_number - String representing any kind of number assigned to complaints or incidents by the police department.

    • +

  • description - Text description of the incident.

    • +

  • street_name - Name of the street the incident occurred, but should not include the street number.

    • +

  • cross_street1, cross_street2 The two closest intersecting streets.

    • +

  • city, state, zip_code State needs to be in 2 letter abbreviated notation.

    • +

  • created_by, last_updated_by - ID of existing user shown as responsible for adding this entry.

    • +

  • officer_ids - IDs of officers involved in the incident, separated by |.

    +
      +

    • Each individual id can either be an integer referring to an existing officer or a string starting with # referring to a newly created officer.

      • +

    • Example: 123|#C1|1627 for three officers, one with id 123, one with 1627 and one whose record was created in the officers csv +and whose id-field was the string #C1.

      • +
    +
    • +

  • license_plates - All license plates involved in the incident. If there is more than one, they can be separated with a |.

    +
      +

    • Each license plate consists of the license plate number and optionally a state in abbreviated form separated by an underscore _.

      • +

    • Example: ABC123_IL|B991 for one license plate with number ABC123 from Illinois and one with number B991 and no associated state.

      • +
    +
    • +
+
+ +
+

Details

+
    +

  • url - Full url of the link starting with http:// or https://.

    • +

  • title - Text that will be displayed as the link.

    • +

  • description - A short description of the link.

    • +

  • link_type - Choice of Link, YouTube Video and Other Video.

    • +

  • author - The source or author of the linked article, report, video.

    • +

  • created_by - ID of existing user shown as responsible for adding this entry.

    • +

  • officer_ids - IDs of officer profiles this link should be visible on, separated by |. See same field in incidents above for more details.

    • +

  • incidents_ids - IDs of incidents this link should be associated with, separated by |. Just like officer_ids this can contain strings. +starting with # to refer to an incident created in the incident csv.

    • +
+
+
+

Examples

+

Example csvs can be found in the repository under OpenOversight/tests/test_csvs.

+
+
+

Local development flag --force-create

+

This flag changes the behavior when an integer is provided as id. Instead of updating an existing record, +a new record will be created and assigned the given id. If a record with that id already exists in the +database, it will be deleted before the new record is created.

+

This functionality is intended to be used to import csv files downloaded from OpenOversight download page </download/all>_ +to get a local copy of the production data for one department in the local development database.

+
+
+ + +
+ +
+
+ +
+
+
+ ©2018, Lucy Parsons Labs. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/area_coordinator.html b/area_coordinator.html new file mode 100644 index 000000000..36b6f18fa --- /dev/null +++ b/area_coordinator.html @@ -0,0 +1,123 @@ + + + + + + + + Area Coordinator — OpenOversight documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Area Coordinator

+

An area coordinator is a person with an account on +OpenOversight that is charged with curating the collection for a particular +department. There can be several area coordinators for a given department. +The tasks they perform include:

+
    +

  • Add new officers

    • +

  • Update officer information, such as new assignments or promotions

    • +

  • Add private notes to particular officer profiles (visible to other area +coordinators or administrators)

    • +

  • Add a brief description to an officer’s profile

    • +

  • Add links and videos to officer’s profiles

    • +

  • Add incidents linked to one or more officers

    • +
+
+ + +
+ +
+
+ +
+
+
+ ©2018, Lucy Parsons Labs. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/bulk_upload.html b/bulk_upload.html new file mode 100644 index 000000000..ec47533b7 --- /dev/null +++ b/bulk_upload.html @@ -0,0 +1,207 @@ + + + + + + + + Using the bulk upload feature — OpenOversight documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Using the bulk upload feature

+

To facilitate adding rosters of new departments or updating existing +departments there is a flask command that gives system administrators +the ability to load the data from a csv file directly into the database.

+

Warning This process is not very robust at this point and there is +risk of leaving the database in an inconsistent state. It is strongly +recommended to back up the database before starting this operation and +to run the command on a development server first and see if the results +are as expected.

+
+

Preparation steps

+
    +

  • Create department if it does not exist

    • +

  • Add ranks in hierarchical order, make sure all the ranks present in +the csv are added

    • +
+
+
+

Layout of the csv file

+

The csv file can have the following fields:

+
 department_id
+ unique_internal_identifier
+ first_name
+ last_name
+ middle_initial
+ suffix
+ gender
+ race
+ employment_date
+ birth_year
+ star_no
+ job_title
+ unit_id
+ start_date
+ resign_date
+ salary
+ salary_year
+ salary_is_fiscal_year
+ overtime_pay
+
+
+
+
+

Explanation of the individual fields

+

General information:

+
    +

  • department_id - ID of department in the server database, for example 1 for Chicago Police Department can be found in +url for that department: https://openoversight.com/departments/1.

    • +

  • unique_internal_identifier - A string or number that can be used to uniquely identify the officer, in departments in +which the badge number stays with the officer using that number is fine, otherwise it is recommended to leave this +blank and provide the star_no instead.

    • +

  • first_name & last_name & middle_initial

    • +

  • suffix - One of the following values: Jr, Sr, II, III, IV, V.

    • +

  • gender - One of the following values: M, F, Other or Not Sure.

    • +

  • race - One of the following values: BLACK, WHITE, ASIAN, HISPANIC, NATIVE AMERICAN, PACIFIC ISLANDER, Other, Not Sure.

    • +

  • employment_date - Start of employment with this department.

    • +

  • birth_year - Integer representing the birth year of the officer in a yyyy format

    • +
+

Current Employment information:

+
    +

  • star_no - Star or badge number, might be related to current rank.

    • +

  • job_title - Rank or title, needs to be added to this department verbatim or Not Sure,

    • +

  • unit_id - ID of unit within the department.

    • +

  • start_date - Start date of this assignment.

    • +

  • resign_date - Resignation date of this assignment.

    • +
+

Salary information: +If adding salary data, the following fields are required: salary_year, +salary_is_fiscal_year, and salary.

+
    +

  • salary_year - Year of which the salary information is provided in a yyyy format.

    • +

  • salary_is_fiscal_year - true or false, salary information is on fiscal year basis vs. calendar year.

    • +

  • salary - Salary in given year.

    • +

  • overtime_pay - Overtime received in given year.

    • +
+

Required fields

+
    +

  • department_id, first_name, last_name, job_title and either star_no or unique_internal_identifier are required.

    • +

  • employment_date, start_date and resign_date can be either in yyyy-mm-dd or mm/dd/yyyy format - if the column is present +the field cannot be left blank.

    • +
+

Command-line options

+
    +

  • --no-create - For each line in the CSV, update an existing officer if one exists, but do not create any new officers. If an officer in the CSV is not already in OpenOversight, the line will be ignored.

    • +

  • --update-by-name - Update officers by first_name and last_name. Useful when unique_internal_identifier and star_no are not available.

    • +

  • --update-static-fields - Allow modifications to normally-static fields like race, birth_year, etc., which OpenOversight normally prevents from being modified. Values in the database will be overwritten with values in the CSV.

    • +
+
+
+

The command to run on the server

+

/usr/src/app/OpenOversight$ flask bulk-add-officers [/path/to/csv_file.csv]

+
+
+ + +
+ +
+
+ +
+
+
+ ©2018, Lucy Parsons Labs. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 000000000..b1ea92762 --- /dev/null +++ b/genindex.html @@ -0,0 +1,105 @@ + + + + + + + Index — OpenOversight documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2018, Lucy Parsons Labs. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..9b844b4e1 --- /dev/null +++ b/index.html @@ -0,0 +1,154 @@ + + + + + + + + Welcome to OpenOversight’s documentation! — OpenOversight documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to OpenOversight’s documentation!

+
+

Contents:

+ +
+

OpenOversight is a Lucy Parsons Labs project to improve law enforcement +accountability through public and crowdsourced data. We maintain a database +of officer demographic information and provide digital galleries of photographs. +This is done to help people identify law enforcement officers for filing +complaints and in order for the public to see work-related information about +law enforcement officers that interact with the public.

+
+
+

Indices and tables

+ +
+ + +
+ +
+
+ +
+
+
+ ©2018, Lucy Parsons Labs. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 000000000..4dbbe6fa9 Binary files /dev/null and b/objects.inv differ diff --git a/search.html b/search.html new file mode 100644 index 000000000..4e90e6138 --- /dev/null +++ b/search.html @@ -0,0 +1,122 @@ + + + + + + + Search — OpenOversight documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + +
+ + +
+ +
+
+ +
+
+
+ ©2018, Lucy Parsons Labs. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 000000000..8356f4801 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Advanced csv import": [[0, "advanced-csv-import"]], "Area Coordinator": [[1, "area-coordinator"]], "Assignments csv": [[0, "assignments-csv"]], "Before you start": [[0, "before-you-start"]], "Contents:": [[3, null]], "Details": [[0, "details"], [0, "id1"], [0, "id2"], [0, "id3"], [0, "id4"]], "Examples": [[0, "examples"]], "Explanation of the command": [[0, "explanation-of-the-command"]], "Explanation of the individual fields": [[2, "explanation-of-the-individual-fields"]], "General overview of the csv import": [[0, "general-overview-of-the-csv-import"]], "Incidents csv": [[0, "incidents-csv"]], "Indices and tables": [[3, "indices-and-tables"]], "Layout of the csv file": [[2, "layout-of-the-csv-file"]], "Links csv": [[0, "links-csv"]], "Local development flag --force-create": [[0, "local-development-flag-force-create"]], "Officers csv": [[0, "officers-csv"]], "Preparation steps": [[2, "preparation-steps"]], "Salaries csv": [[0, "salaries-csv"]], "Special Flag": [[0, "special-flag"]], "The command to run on the server": [[2, "the-command-to-run-on-the-server"]], "The id field": [[0, "the-id-field"]], "Using the bulk upload feature": [[2, "using-the-bulk-upload-feature"]], "Welcome to OpenOversight\u2019s documentation!": [[3, "welcome-to-openoversight-s-documentation"]]}, "docnames": ["advanced_csv_import", "area_coordinator", "bulk_upload", "index"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["advanced_csv_import.md", "area_coordinator.md", "bulk_upload.md", "index.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 1], "1": 2, "123": 0, "1627": 0, "2": 0, "24h": 0, "5": 0, "A": [0, 2], "And": 0, "For": [0, 2], "If": [0, 2], "In": 0, "It": 2, "Not": 2, "One": [0, 2], "That": 0, "The": [1, 3], "Then": 0, "There": 1, "To": 2, "Will": 0, "With": 0, "_": 0, "_ref": 0, "abbrevi": 0, "abc123": 0, "abc123_il": 0, "abil": 2, "about": [0, 3], "abov": 0, "accept": 0, "accord": 0, "account": [1, 3], "aci": 0, "ad": [0, 2], "add": [0, 1, 2], "addit": 0, "administr": [1, 2], "advanc": 3, "advanced_csv_import": 0, "after": 0, "air_traff": 0, "all": [0, 2], "allow": [0, 2], "alreadi": [0, 2], "also": 0, "alwai": 0, "american": [0, 2], "amount": 0, "an": [0, 1, 2], "ani": [0, 2], "anoth": 0, "app": [0, 2], "appendix_a": 0, "appropri": 0, "ar": [0, 2], "area": 3, "argument": 0, "articl": 0, "asian": [0, 2], "assign": [1, 2, 3], "associ": 0, "assum": 0, "atpub": 0, "author": 0, "auxiliari": 0, "avail": [0, 2], "b991": 0, "back": [0, 2], "badg": [0, 2], "badge_numb": 0, "base": 0, "basi": 2, "befor": [2, 3], "behavior": 0, "being": 2, "belong": 0, "better": 0, "birth": [0, 2], "birth_year": [0, 2], "black": [0, 2], "blank": [0, 2], "boolean": 0, "both": 0, "brief": 1, "bulk": [0, 3], "bulk_upload": 0, "c1": 0, "calendar": [0, 2], "can": [0, 1, 2], "cannot": 2, "case": 0, "chanc": 0, "chang": 0, "charact": 0, "charg": 1, "chicago": 2, "choic": 0, "citi": 0, "closest": 0, "cnt_html": 0, "collect": 1, "column": [0, 2], "com": 2, "command": 3, "commit": 0, "complaint": [0, 3], "complet": 0, "complic": 0, "consid": 0, "consist": 0, "contain": 0, "coordin": 3, "copi": 0, "correctli": 0, "correspond": 0, "creat": [2, 3], "created_bi": 0, "cross_street1": 0, "cross_street2": 0, "crowdsourc": 3, "csv": 3, "csv_file": 2, "curat": 1, "current": [0, 2], "data": [0, 2, 3], "databas": [0, 2, 3], "dataset": 0, "date": [0, 2], "dd": [0, 2], "decis": 0, "delet": 0, "demograph": 3, "depart": [0, 1, 2], "department_id": 2, "department_nam": 0, "department_st": 0, "descript": [0, 1], "design": 0, "detail": 3, "develop": [2, 3], "didn": 0, "digit": 3, "directli": 2, "displai": 0, "do": 2, "document": 0, "doe": [0, 2], "done": 3, "download": 0, "each": [0, 2], "earli": 0, "either": [0, 2], "employ": [0, 2], "employment_d": [0, 2], "empti": 0, "encount": 0, "end": 0, "enforc": 3, "entri": 0, "environ": 0, "etc": 2, "exactli": 0, "exampl": [2, 3], "except": 0, "exist": [0, 2], "exit": 0, "expect": [0, 2], "explan": 3, "f": [0, 2], "faa": 0, "facilit": 2, "fail": 0, "fals": 2, "featur": 3, "few": 0, "field": 3, "file": [0, 3], "final": 0, "fine": [0, 2], "first": [0, 2], "first_nam": [0, 2], "fiscal": [0, 2], "flag": 3, "flask": [0, 2], "follow": [0, 2], "forc": 3, "form": 0, "format": [0, 2], "found": [0, 2], "from": [0, 2], "full": 0, "function": 0, "galleri": 3, "gender": [0, 2], "gener": [2, 3], "get": 0, "give": 2, "given": [0, 1, 2], "gov": 0, "ha": 0, "have": [0, 2], "header": 0, "help": [0, 3], "hh": 0, "hierarch": 2, "highli": 0, "hispan": [0, 2], "histor": 0, "howev": 0, "html": 0, "http": [0, 2], "i": [0, 1, 2, 3], "id": [2, 3], "identifi": [0, 2, 3], "ignor": [0, 2], "ii": [0, 2], "iii": [0, 2], "illinoi": 0, "import": 3, "improv": 3, "incid": [1, 3], "incident_id": 0, "incidents_id": 0, "includ": [0, 1], "inconsist": [0, 2], "index": 3, "indic": 0, "individu": [0, 3], "inform": [0, 1, 2, 3], "insert": 0, "insid": 0, "instanc": 0, "instead": [0, 2], "instruct": 0, "integ": [0, 2], "intend": 0, "interact": 3, "intersect": 0, "involv": 0, "is_fiscal_year": 0, "island": [0, 2], "iv": [0, 2], "job": 0, "job_titl": [0, 2], "jr": [0, 2], "just": 0, "kind": 0, "lab": 3, "last_nam": [0, 2], "last_updated_bi": 0, "law": 3, "layout": 3, "lead": 0, "leav": 2, "left": [0, 2], "less": 0, "letter": 0, "licens": 0, "license_pl": 0, "like": [0, 2], "line": 2, "link": [1, 3], "link_typ": 0, "list": 0, "littl": 0, "load": 2, "local": 3, "locat": 0, "logic": 0, "loss": 0, "luci": 3, "m": [0, 2], "maintain": 3, "make": [0, 2], "mandatori": 0, "mani": 0, "match": 0, "merg": 0, "messag": 0, "middle_initi": [0, 2], "might": [0, 2], "mix": 0, "mm": [0, 2], "model": 0, "modif": 2, "modifi": 2, "more": [0, 1], "most": 0, "most_recent_salari": 0, "name": [0, 2], "nativ": [0, 2], "need": [0, 2], "new": [0, 1, 2], "newli": 0, "non": 0, "normal": 2, "notat": 0, "note": 1, "null": 0, "number": [0, 2], "occur": 0, "offer": 0, "offic": [1, 2, 3], "officer_id": 0, "one": [0, 1, 2], "onli": 0, "openoversight": [0, 1, 2], "oper": 2, "option": [0, 2], "order": [2, 3], "other": [0, 1, 2], "otherwis": [0, 2], "overtim": [0, 2], "overtime_pai": [0, 2], "overview": 3, "overwrit": 0, "overwritten": [0, 2], "pacif": [0, 2], "page": [0, 3], "parson": 3, "part": 0, "particular": [0, 1], "path": [0, 2], "payment": 0, "peopl": 3, "perform": 1, "person": 1, "photograph": 3, "plate": 0, "point": 2, "polic": [0, 2], "possibl": 0, "power": 0, "prepar": [0, 3], "present": [0, 2], "pretti": 0, "prevent": [0, 2], "primari": 0, "privat": 1, "problem": 0, "process": 2, "product": 0, "profil": [0, 1], "project": 3, "promot": 1, "provid": [0, 2, 3], "public": [0, 3], "purpos": 0, "race": [0, 2], "rank": 2, "receiv": [0, 2], "recommend": [0, 2], "record": 0, "reduc": 0, "ref": 0, "refer": 0, "referenc": 0, "relat": [2, 3], "relationship": 0, "relev": 0, "replic": 0, "report": 0, "report_numb": 0, "repositori": 0, "repres": [0, 2], "requir": [0, 2], "resign": 2, "resign_d": [0, 2], "respect": 0, "respons": 0, "result": [0, 2], "risk": 2, "robust": 2, "roster": 2, "row": 0, "run": [0, 3], "salari": [2, 3], "salary_is_fiscal_year": 2, "salary_year": 2, "same": 0, "search": 3, "section": 0, "see": [0, 2, 3], "sensit": 0, "separ": 0, "server": [0, 3], "sever": 1, "short": 0, "should": 0, "show": 0, "shown": 0, "simplifi": 0, "so": 0, "some": 0, "sourc": 0, "space": 0, "special": 3, "sql": 0, "sr": [0, 2], "src": [0, 2], "ss": 0, "stai": [0, 2], "standard": 0, "star": [0, 2], "star_no": 2, "start": [2, 3], "start_dat": [0, 2], "state": [0, 2], "static": 2, "step": 3, "street": 0, "street_nam": 0, "string": [0, 2], "strongli": [0, 2], "suffix": [0, 2], "suppos": 0, "sure": 2, "system": 2, "t": 0, "tabl": 0, "task": 1, "test": 0, "test_csv": 0, "text": 0, "than": 0, "thei": [0, 1], "them": 0, "therefor": 0, "thi": [0, 2, 3], "third": 0, "three": 0, "through": 3, "time": 0, "timezon": 0, "titl": [0, 2], "treat": 0, "true": [0, 2], "truth": 0, "two": 0, "under": 0, "underscor": 0, "uniqu": [0, 2], "unique_identifi": 0, "unique_internal_identifi": [0, 2], "unit": [0, 2], "unit_id": [0, 2], "unit_nam": 0, "unus": 0, "up": [0, 2], "updat": [0, 1, 2], "upload": [0, 3], "url": [0, 2], "us": [0, 3], "usag": 0, "user": 0, "usr": [0, 2], "usual": 0, "v": [0, 2], "valu": [0, 2], "verbatim": 2, "veri": 2, "video": [0, 1], "visibl": [0, 1], "wa": 0, "wai": 0, "warn": [0, 2], "we": 3, "when": [0, 2], "where": 0, "whether": 0, "which": [0, 2], "white": [0, 2], "whose": 0, "within": [0, 2], "work": 3, "wrong": 0, "www": 0, "y": 0, "ye": 0, "year": [0, 2], "you": 3, "youtub": 0, "yyyi": [0, 2], "zip_cod": 0}, "titles": ["Advanced csv import", "Area Coordinator", "Using the bulk upload feature", "Welcome to OpenOversight\u2019s documentation!"], "titleterms": {"": 3, "The": [0, 2], "advanc": 0, "area": 1, "assign": 0, "befor": 0, "bulk": 2, "command": [0, 2], "content": 3, "coordin": 1, "creat": 0, "csv": [0, 2], "detail": 0, "develop": 0, "document": 3, "exampl": 0, "explan": [0, 2], "featur": 2, "field": [0, 2], "file": 2, "flag": 0, "forc": 0, "gener": 0, "id": 0, "import": 0, "incid": 0, "indic": 3, "individu": 2, "layout": 2, "link": 0, "local": 0, "offic": 0, "openoversight": 3, "overview": 0, "prepar": 2, "run": 2, "salari": 0, "server": 2, "special": 0, "start": 0, "step": 2, "tabl": 3, "upload": 2, "us": 2, "welcom": 3, "you": 0}}) \ No newline at end of file