Improve examples in docs (#16)

* Fix return types and color band range (#5)

* fix types and remove non-existing function

* fix tests

* fix color band range

* increment patch number

* fix range and tests

* changelog

* bring back function

* more tests

* missing include

* typo

* better docstrings

* correctness

* ws

* docs only publish

* more examples

* point to pypi (#3)

* remove multi-statement lines

* remove vb references

* better explanation

* simpler

* cleanup and make sure the scripts work

* Update readme.rst

* remove unnecessary fallback

Author: osinjoku

.github/workflows/publish.yml

@@ -7,6 +7,11 @@ on:
         description: "Confirm publish package"
         required: true
         type: boolean
+      docs_only:
+        description: "Only publish documentation (skip package publish)"
+        required: false
+        type: boolean
+        default: false
 
 jobs:
   guard-ci-success:
@@ -77,9 +82,16 @@ jobs:
         with:
           python-version: '3.13'
 
+      - name: Install dependencies for docs
+        if: ${{ github.event.inputs.docs_only == 'true' }}
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Check if version exists on PyPI
         id: pypi_check
         shell: pwsh
+        if: ${{ github.event.inputs.docs_only != 'true' }}
         run: |
           $packageName = 'moldflow'
 
@@ -100,30 +112,30 @@ jobs:
           "version=$version" | Out-File -FilePath $env:GITHUB_OUTPUT -Append -Encoding utf8
 
       - name: Skip publish, version already exists
-        if: steps.pypi_check.outputs.exists == 'true'
+        if: ${{ github.event.inputs.docs_only != 'true' && steps.pypi_check.outputs.exists == 'true' }}
         run: Write-Output "Version ${{ steps.pypi_check.outputs.version }} already exists on PyPI. Skipping publish."
 
       - name: Install build dependencies
-        if: steps.pypi_check.outputs.exists == 'false'
+        if: ${{ github.event.inputs.docs_only != 'true' && steps.pypi_check.outputs.exists == 'false' }}
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
 
       - name: Build package
-        if: steps.pypi_check.outputs.exists == 'false'
+        if: ${{ github.event.inputs.docs_only != 'true' && steps.pypi_check.outputs.exists == 'false' }}
         run: |
           python run.py build
 
       - name: Publish to PyPI
-        if: steps.pypi_check.outputs.exists == 'false'
+        if: ${{ github.event.inputs.docs_only != 'true' && steps.pypi_check.outputs.exists == 'false' }}
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
         run: |
           python run.py publish --skip-build
 
       - name: Create GitHub Release
-        if: steps.pypi_check.outputs.exists == 'false'
+        if: ${{ github.event.inputs.docs_only != 'true' && steps.pypi_check.outputs.exists == 'false' }}
         run: |
           python run.py release
         env: