ixbrl-viewer 1.4.56__tar.gz → 1.4.57__tar.gz

ixbrl_viewer-1.4.57/.github/workflows/build-documentation.yml

@@ -0,0 +1,30 @@
+name: Build Documentation
+
+on:
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions: {}
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - name: Install Python
+        uses: actions/setup-python@v5.4.0
+        with:
+          cache: 'pip'
+          cache-dependency-path: **/requirements-docs.txt
+          check-latest: true
+          python-version: '3.12'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install -r requirements-docs.txt
+      - name: Build documentation
+        env:
+          SPHINXOPTS: -T -W --keep-going
+        run: make -C docs html

ixbrl_viewer-1.4.57/.github/workflows/publish-documentation.yml

@@ -0,0 +1,27 @@
+name: Publish Documentation
+
+on:
+  workflow_call:
+    inputs:
+      branch:
+        default: 'master'
+        description: 'branch to trigger RTD builds for'
+        required: false
+        type: string
+  workflow_dispatch:
+    inputs:
+      branch:
+        default: 'master'
+        description: 'branch to trigger RTD builds for'
+        required: true
+        type: string
+
+permissions: {}
+
+jobs:
+  publish-documentation:
+    environment: release
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Trigger RTD builds for input branch and any new tags
+        run: curl -X POST -d "branches=${{ inputs.branch }}" -d "token=${{ secrets.RTD_TOKEN }}" -d "default_branch=master" "${{ secrets.RTD_WEBHOOK }}"

{ixbrl_viewer-1.4.56 → ixbrl_viewer-1.4.57}/.github/workflows/release.yml

@@ -7,6 +7,10 @@ on:
 permissions: {}
 
 jobs:
+  publish-documentation:
+    uses: ./.github/workflows/publish-documentation.yml
+    secrets: inherit
+
   node-tests:
     uses: ./.github/workflows/node-tests.yml
   npm-package:

{ixbrl_viewer-1.4.56 → ixbrl_viewer-1.4.57}/.gitignore

@@ -6,6 +6,8 @@
 build
 node_modules/
 dist/
+docs/_build
+docs/source/apidocs
 __pycache__
 /tests/puppeteer/artifacts/
 iXBRLViewerPlugin/viewer/src/fonts/

ixbrl_viewer-1.4.57/.readthedocs.yaml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - requirements: requirements-docs.txt
+
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: true

ixbrl_viewer-1.4.56/LICENSE → ixbrl_viewer-1.4.57/LICENSE.md

@@ -1,22 +1,16 @@
+# License
 
+Copyright © 2019-present Workiva, Inc.
 
-ixbrl-viewer
-
-Copyright 2019 Workiva Inc.
-
-
-Licensed under the Apache License, Version 2.0 (the "License"); 
+Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
+<http://www.apache.org/licenses/LICENSE-2.0>
 
-http://www.apache.org/licenses/LICENSE-2.0
-
-
-Unless required by applicable law or agreed to in writing, software 
-distributed under the License is distributed on an "AS IS" BASIS, 
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
-See the License for the specific language governing permissions and
-limitations under the License.
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
 
 ---
 This ixbrl-viewer software includes a number of subcomponents with separate copyright notices and/or license

{ixbrl_viewer-1.4.56 → ixbrl_viewer-1.4.57}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ixbrl-viewer
-Version: 1.4.56
+Version: 1.4.57
 Summary: The Arelle iXBRL Viewer allows iXBRL reports to be viewed interactively in a web browser.
 Author-email: "arelle.org" <support@arelle.org>
 License: Apache-2.0
@@ -27,7 +27,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Text Processing :: Markup :: XML
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
+License-File: LICENSE.md
 License-File: NOTICE
 Requires-Dist: lxml<6,>=4
 Provides-Extra: arelle
@@ -35,7 +35,7 @@ Requires-Dist: arelle_release==2.*; extra == "arelle"
 Provides-Extra: dev
 Requires-Dist: flake8==7.1.1; extra == "dev"
 Requires-Dist: lxml-stubs==0.5.1; extra == "dev"
-Requires-Dist: mypy==1.14.1; extra == "dev"
+Requires-Dist: mypy==1.15.0; extra == "dev"
 Requires-Dist: pytest==8.3.4; extra == "dev"
 Requires-Dist: typing-extensions==4.12.2; extra == "dev"
 

ixbrl_viewer-1.4.57/docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ixbrl_viewer-1.4.57/docs/make.bat

@@ -0,0 +1,40 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+if "%1" == "livehtml" goto livehtml
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:livehtml
+sphinx-autobuild %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

ixbrl_viewer-1.4.57/docs/source/_static/css/extra.css

@@ -0,0 +1,5 @@
+#command-line-operation code.literal {
+    white-space: nowrap;
+}
+
+

ixbrl_viewer-1.4.57/docs/source/build_docs.md

@@ -0,0 +1,45 @@
+# Building Documentation
+
+:::{index} Building Documentation
+:::
+
+Arelle's iXBRL Viewer documentation is built using Sphinx and published to [Read the Docs][read-the-docs-project].
+
+[read-the-docs-project]: https://arelle-ixbrl-viewer.readthedocs.io/
+
+## Build Locally
+
+1. Install documentation dependencies.
+
+   ```shell
+   pip install -r requirements-docs.txt
+   ```
+
+2. Navigate to the `docs` directory.
+
+   ```shell
+   cd docs
+   ```
+
+3. Build HTML documentation
+   * Linux or macOS
+
+     ```shell
+     # build
+     make html
+     # or auto rebuild on file changes (useful when working on documentation)
+     make livehtml
+     ```
+
+   * Windows
+
+     ```powershell
+     # build
+     .\make.bat html
+     # or auto rebuild on file changes (useful when working on documentation)
+     .\make.bat livehtml
+     ```
+
+4. Open documentation:
+    * file `docs/_build/html/index.html` if using `make html`
+    * <http://127.0.0.1:8000/> if using `make livehtml`

ixbrl_viewer-1.4.57/docs/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Arelle iXBRL Viewer"
+copyright = "2019-present Workiva, Inc."
+author = "support@arelle.org"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "autodoc2",
+    "myst_parser",
+    "sphinx_copybutton",
+]
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+autodoc2_packages = [
+    {
+        "path": "../../iXBRLViewerPlugin",
+        "exclude_dirs": ["dist"],
+    }
+]
+autodoc2_render_plugin = "myst"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_theme_options = {
+    "light_css_variables": {
+        "color-brand-primary": "#ac218e",
+        "color-brand-content": "#ac218e",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#6ecacb",
+        "color-brand-content": "#6ecacb",
+    },
+}
+html_title = "Arelle iXBRL Viewer <release>"
+html_favicon = "_images/favicon.ico"
+html_logo = "_images/arelle-rtd.png"
+
+myst_enable_extensions = [
+    "colon_fence",
+    "fieldlist",
+]
+myst_heading_anchors = 6
+
+pygments_style = "xcode"
+pygments_dark_style = "monokai"

ixbrl_viewer-1.4.57/docs/source/index.md

@@ -0,0 +1,11 @@
+:::{include} ../../README.md
+:::
+
+:::{toctree}
+:hidden:
+user_guides/user_guide
+build_docs
+license
+apidocs/index
+genindex
+:::

ixbrl_viewer-1.4.57/docs/source/license.md

@@ -0,0 +1,5 @@
+:::{include} ../../LICENSE.md
+:::
+
+:::{index} License
+:::

ixbrl_viewer-1.4.57/docs/source/user_guides/user_guide.md

@@ -0,0 +1,248 @@
+# User Guide
+
+:::{index} User Guide
+:::
+
+## Overview
+
+The Arelle Inline XBRL (iXBRL) Viewer allows you to access, view and
+interact with tagged XBRL data in iXBRL documents from your web browser.
+
+Key features include:
+
+-   Full text search on taxonomy labels and references
+-   View full details of tagged facts
+-   Export tables to Excel
+-   Visualise and navigate calculation relationships
+-   Produce on-the-fly graphs using XBRL data
+
+## Viewing the Report
+
+The Inline XBRL Viewer consists of the following components:
+
+-   Viewer pane - This area, taking up most of the screen, shows the
+    filed document.
+-   XBRL inspector - This area on the right shows information about the
+    currently-selected fact and allows navigation of the document using
+    XBRL Information.
+-   Toolbar - This area along the top of the viewer contains general
+    controls for the viewer..
+
+The viewer pane allows you to browse information in the report that has
+been tagged as XBRL by clicking on it to see tag details in the XBRL
+inspector. The viewer pane has controls for zooming and printing the
+Inline XBRL document, andalso for exporting the data in individual
+tables.
+
+You can also navigate between facts in the document using the left and
+right arrows at the top of the XBRL inspector. Moving between facts will
+move the viewing area to the selected fact and highlight the tagged
+information in the viewer pane. Some XBRL tags contain information that
+is not shown in the document. These are referred to as "hidden facts"
+and are indicated by a "hidden fact" message at the top of the XBRL
+inspector when selected. No information will be highlighted in the
+viewer pane when a hidden fact is selected.
+
+![image](../_images/user_guides/viewing_the_report.png)
+
+### Highlighting Facts
+
+The "Highlight XBRL Elements" checkbox on the toolbar can be used to
+highlight all tagged information in the document. Different colors
+represent different namespaces, which can be seen by hovering over the
+(?) icon. Note that not all of the namespaces used by the document may
+be visible if, for example, a given namespace is only used in
+dimensions.
+
+## Fact Properties
+
+When an XBRL fact is selected, information about the fact will be shown
+in the XBRL inspector. This includes:
+
+-   Concept name
+-   Concept description
+-   Dimensions (if any)
+-   Date or date range
+-   Fact value
+-   Accuracy
+-   Scale
+-   Change
+-   Entity
+-   Concept
+-   Type
+-   Balance
+-   Concept Labels
+-   Concept References
+-   Anchoring information (if applicable)
+-   Calculations (if applicable)
+-   Footnotes (if applicable)
+-   Sections
+
+![image](../_images/user_guides/fact_properties.png)
+
+### Analysis charts
+
+The icon next to the Date property will display a chart of the
+currently-selected fact compared against correspondingly-tagged facts
+from other periods in the report. If the fact has dimensions, each
+dimension will also have an icon you can click to show a chart of the
+currently-selected fact compared against correspondingly-tagged facts
+with different values for that dimension. For example, if a dimension is
+used to provide a breakdown by business segment, the chart will show the
+correspondingly-tagged fact for each business segment. Dimensions shown
+on the chart can be toggled using the buttons below the chart. Up to two
+dimensions can be plotted at a time.
+
+### Change from prior period
+
+The Change property shows the percentage change of the current fact
+compared to the corresponding value from the prior period, if such a
+tagged value exists. Clicking on the comparative period will focus the
+fact inspector on the prior period fact.
+
+### Entity information
+
+The Entity property shows the entity identifier that the fact is
+reported against. Typically this will be the same for all facts in the
+report and will be either the UK Company Registration number or the
+Legal Entity Identifier. You can click the link to search the identifier
+on the Companies House or GLEIF website in a new browser tab.
+
+### Fact locations
+
+If the current fact appears in more than one location in the document,
+the left and right arrow buttons at the bottom of the properties pane
+can be used to cycle through the different occurrences.
+
+![image](../_images/user_guides/fact_locations.png)
+
+## XBRL Inspector Panels
+
+By default, the XBRL Inspector will show the Fact Properties panel,
+which shows information about the currently selected fact. The inspector
+has three other modes, which can be selected using the icons at the top
+of the XBRL Inspector:
+
+-   Document Summary
+-   Document Outline
+-   Search
+
+To return to the Fact Properties panel, click on the same icon again or
+use the back button to the left of the panel title.
+
+### Document Summary
+
+The Document Summary mode shows information about the XBRL data in the
+document, including the total number of XBRL facts, the number of hidden
+facts and files included in the filing. The summary also includes the
+number of distinct concepts, dimensions and members in the report. You
+can click on the fact count to enter Search mode.
+
+::: note
+::: title
+Note
+:::
+
+The number of concepts will be less than the total number of facts, as
+concepts will often be reported for different periods and with different
+dimensions.
+:::
+
+![image](../_images/user_guides/document_summary.png)
+
+### Document Outline
+
+The List icon toggles the Document Outline panel, which displays
+sections of the document based on the structure of the XBRL Taxonomy
+used to tag the document. Select a section to move to the start of that
+section in the document.
+
+![image](../_images/user_guides/document_outline.png)
+
+### Search
+
+The magnifying glass icon toggles the Search panel, where a powerful
+search function allows you to find information in the document using
+XBRL data. By default, all XBRL facts in the document are displayed in
+the search results. You can use the search and filter controls at the
+top of the search panel to examine a fact or facts more closely.
+
+Entering terms into the search bar of the Search panel shows a list of
+matching facts from the report. The search will match against
+information from the XBRL Taxonomy, including concept and dimension
+labels. The results are ordered according to match quality, with the
+best matches shown first. Entering multiple search terms will show all
+facts that match at least one term. Prefixing a search term with "+"
+will restrict the results to those that contain that term.
+
+![image](../_images/user_guides/search_results.png)
+
+Selecting a fact in the results will scroll the viewer pane to that fact
+at its location in the document. Double clicking on a fact in the
+results or using the arrow icon will close the search panel and focus on
+that fact in the Fact Properties panel.
+
+Search results can be customised using the filter functionality accessed
+using the filter icon to the right of the search bar. Apply filters by
+checking or unchecking boxes, by selecting the filter dropdown and
+making a selection, or by choosing an option from the filter category.
+
+The filter icon will be highlighted to indicate when there are active
+filters, and a "reset" link will appear that will remove all filters.
+Clicking on the filter icon again will close the filter controls, but
+the filters will remain active.
+
+Filters include:
+
+-   Concept type
+-   Fact value
+-   Hidden (or visible) facts
+-   Period
+-   Namespaces
+-   Types
+-   Units
+-   Scales
+-   Dimension type
+-   Calculations
+
+![image](../_images/user_guides/search_filters.png)
+
+## Table Export
+
+Tables containing XBRL tags have a green diamond icon in the top left
+corner. Mousing over this icon will show an "Export Table" link.
+Clicking this will export data from the table as an Excel spreadsheet.
+
+The exported table will include the descriptions used in the document
+alongside the labels for the XBRL concepts and dimensions used to tag
+the facts in the currently selected document language. This feature can
+be used to review documents that have been prepared in a different
+language.
+
+## Toolbar Controls
+
+Checking the "Highlight XBRL Elements" option on the toolbar will
+highlight all information in the document tagged with XRBL. The
+highlighting is colour-coded to indicate which taxonomy (or part of a
+taxonomy) was used to tag the fact. You can view a key for highlight
+colours by mousing over the question mark icon in the toolbar.
+
+The toolbar also has the following controls:
+
+-   Dark Mode - selecting the dark mode icon at the top of the Fact
+    Properties panel will toggle "dark mode". Dark mode changes the
+    interface to use light text on a dark background.
+-   Settings Menu - the gear icon on the right of the toolbar provides a
+    menu with a number of viewer settings. These include:
+    -   Document language -- if the XBRL taxonomy used to prepare the
+        document contains more than one language, you can choose the
+        language here to adjust the language used when displaying labels
+        for concepts, dimensions and members.
+    -   Application language -- this controls the language of the Inline
+        XBRL Viewer user interface.
+-   Calculations mode - the "Calculations v1.1" checkbox controls how
+    numeric facts in the document are checked against calculation
+    relationships in the XBRL Taxonomy. It is recommended that
+    Calculations v1.1 is enabled.
+
+![image](../_images/user_guides/toolbar_controls.png)

{ixbrl_viewer-1.4.56 → ixbrl_viewer-1.4.57}/iXBRLViewerPlugin/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.56'
-__version_tuple__ = version_tuple = (1, 4, 56)
+__version__ = version = '1.4.57'
+__version_tuple__ = version_tuple = (1, 4, 57)