fix: errors and warnings in make livehtml
#109
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,7 +103,8 @@ Cluster: Health | |
| Incident: 2025 Southwest Monsoon Floods | ||
| ``` | ||
|
|
||
| <!-- TODO: Add screenshot: Cluster selection on request form --> | ||
| <!--  --> | ||
|
|
||
| ```{note} | ||
| The cluster codes follow UN OCHA standards and should not be modified. If your country uses different sector names, create custom translations in **Settings → Translations** rather than changing the codes. | ||
|
|
@@ -127,7 +128,8 @@ Priority affects: | |
| - **Alert generation** - Overdue critical requests trigger automatic alerts | ||
| - **Approval routing** - Critical requests may bypass certain approval steps | ||
|
|
||
| <!-- TODO: Add screenshot: Priority field on request --> | ||
| <!--  --> | ||
|
|
||
| ```{tip} | ||
| You can add custom priority levels (e.g., `routine` for regular stock replenishment) by adding vocabulary codes. See "Adding Custom Vocabulary Codes" below. | ||
|
|
@@ -153,7 +155,8 @@ Condition is recorded: | |
| - **On distribution** - When dispatching to beneficiaries | ||
| - **On return** - When items come back from field | ||
|
|
||
| <!-- TODO: Add screenshot: Item condition selection during inspection --> | ||
| <!--  --> | ||
|
|
||
| ```{warning} | ||
| Items marked `damaged` or `expired` should not be distributed. DRIMS can generate alerts when such items remain in inventory beyond a threshold period. | ||
|
|
@@ -184,7 +187,8 @@ This helps DRIMS: | |
| - Route information to the right stakeholders | ||
| - Track agency roles correctly | ||
|
|
||
| <!-- TODO: Add screenshot: Coordination mode on incident --> | ||
| <!--  --> | ||
|
|
||
| ## Organization Roles | ||
|
|
||
|
|
@@ -215,13 +219,15 @@ You can extend vocabularies with country-specific or program-specific codes with | |
|
|
||
| Go to **DRIMS → Configuration → Vocabularies**. | ||
|
|
||
| <!-- TODO: Add screenshot: Vocabularies menu --> | ||
| <!--  --> | ||
|
|
||
| ### Step 2: Select the Vocabulary | ||
|
|
||
| Click on the vocabulary you want to extend (e.g., "Priority Levels"). | ||
|
|
||
| <!-- TODO: Add screenshot: Select vocabulary --> | ||
| <!--  --> | ||
|
|
||
| ### Step 3: Add a New Code | ||
|
|
||
|
|
@@ -234,7 +240,8 @@ Click **Add a line** in the Codes section. | |
| | **URI** | (auto-generated) | Leave blank - system generates | | ||
| | **Deprecated** | Unchecked | Check to hide from dropdowns | | ||
|
|
||
| <!-- TODO: Add screenshot: Add vocabulary code --> | ||
| <!--  --> | ||
|
|
||
| ### Step 4: Save | ||
|
|
||
|
|
@@ -244,7 +251,8 @@ Click **Save** to activate the new code. | |
|
|
||
| Open a request form and check that the new priority level appears in the dropdown. | ||
|
|
||
| <!-- TODO: Add screenshot: New code in dropdown --> | ||
| <!--  --> | ||
|
|
||
| ```{important} | ||
| **Code naming rules:** | ||
|
|
@@ -321,7 +329,8 @@ To see all vocabularies and their codes: | |
| 2. Use the search and filters to find specific vocabularies | ||
| 3. Click any vocabulary to view and edit its codes | ||
|
|
||
| <!-- TODO: Add screenshot: Vocabulary list --> | ||
| <!--  --> | ||
|
|
||
| ## Are You Stuck? | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,13 +52,15 @@ Before a warehouse can be used for disaster response operations, it must be enab | |
|
|
||
| 1. Navigate to **DRIMS → Inventory → Warehouses** | ||
|
|
||
| <!-- TODO: Add screenshot: DRIMS inventory menu --> | ||
| <!--  --> | ||
|
|
||
| 2. Select an existing warehouse or create a new one using the **New** button | ||
|
|
||
| 3. In the warehouse form, check the **DRIMS Warehouse** checkbox | ||
|
|
||
| <!-- TODO: Add screenshot: DRIMS warehouse checkbox --> | ||
| <!--  --> | ||
|
|
||
| 4. Configure the DRIMS-specific fields (see next section) | ||
|
|
||
|
|
@@ -75,7 +77,8 @@ Once a warehouse is DRIMS-enabled, configure these fields: | |
| | **Area** | Dropdown | Recommended | Geographic location from the area hierarchy | | ||
| | **Linked Incidents** | Multi-select | Optional | Specific disasters this warehouse serves | | ||
|
|
||
| <!-- TODO: Add screenshot: DRIMS warehouse configuration form --> | ||
| <!--  --> | ||
|
|
||
| ### Field Details | ||
|
|
||
|
|
@@ -124,7 +127,8 @@ You can associate warehouses with specific disaster incidents in two ways: | |
| 4. Select warehouses from the list | ||
| 5. Save the incident | ||
|
|
||
| <!-- TODO: Add screenshot: Incident warehouses tab --> | ||
| <!--  --> | ||
|
|
||
| **When to link warehouses to incidents:** | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,7 +29,8 @@ If your deployment includes the Roles feature, OpenSPP shows a banner on the use | |
| 1. Go to **Settings → Users & Companies → Users** and click **Create**. | ||
| 2. Fill in name and email/login, then **Save**. | ||
|
|
||
| <!-- TODO: Add screenshot: User creation form --> | ||
| <!--  --> | ||
|
|
||
| ### Assign roles (recommended) | ||
|
|
||
|
|
@@ -40,7 +41,8 @@ If your deployment includes the Roles feature, OpenSPP shows a banner on the use | |
| - **From / To** (optional): time-bound access | ||
| - **Enabled**: turn the role on/off | ||
|
|
||
| <!-- TODO: Add screenshot: Roles tab on the user form with one enabled role line --> | ||
| <!--  --> | ||
|
|
||
| ### Restrict access to an area (local roles) | ||
|
|
||
|
|
@@ -50,7 +52,8 @@ If the Areas module is installed, roles can be assigned as **local** and scoped | |
| - OpenSPP computes the user's "Center Areas" based on local role assignments. | ||
| - Record rules in domain modules can use the user's center areas to restrict which records are visible. | ||
|
|
||
| <!-- TODO: Add screenshot: Role line with a selected Center Area and the computed Center Areas field on the user --> | ||
| <!--  --> | ||
|
|
||
| ### Remove or suspend access | ||
|
|
||
|
|
@@ -72,7 +75,8 @@ You can create new roles that combine multiple groups: | |
| 2. Create a role and add the implied groups it should grant. | ||
| 3. Assign the role to users on the user form. | ||
|
|
||
| <!-- TODO: Add screenshot: Settings → Users & Companies → Roles for custom role configuration --> | ||
| <!--  --> | ||
|
|
||
| ```{note} | ||
| For long-term maintainability, prefer implementing new privileges/groups/roles in an OpenSPP module (XML/CSV) rather than changing core security definitions from the UI. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -238,14 +238,19 @@ Kenya CT-OVC Active Codes: | |
| |-------|-------| | ||
| | API Vocabulary Validation | Strict | | ||
|
|
||
| **Request:** | ||
| ``` | ||
| POST /api/v2/individuals | ||
| { | ||
| "gender": "urn:iso:std:iso:5218#9" | ||
| } | ||
| ``` | ||
|
|
||
| Note: "Not Applicable" (code #9) is not in the profile. | ||
|
|
||
| **Response:** 400 Bad Request | ||
|
|
||
| ```json | ||
| { | ||
| "error": "Code not in active deployment profile", | ||
| "code": "urn:iso:std:iso:5218#9", | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this patch for
werkzeug.routing.NumberConverteris a clever and necessary workaround for building the documentation with newer dependencies, it's worth noting that monkey-patching a library like this can be fragile. It might be beneficial to add a comment pointing to an upstream issue or discussion in Odoo or Werkzeug if one exists, to track a more permanent solution. This would help future maintainers understand the context and eventually remove the patch when it's no longer needed.