dtocean-docs
Provides an offline copy of the DTOcean documentation.
Part of the DTOcean suite of tools.
Installation
pip install dtocean-docs
Usage
To access the documentation from the DTOcean GUI (see dtocean-app), open
the Help menu and choose the Index... option.
The documentation can also be opened in a separate browser (without the need to install dtocean-app) by using following command:
dtocean-docs
Alternatively, if dtocean-core is installed, the docs can be opened using:
dtocean docs
Development
Development of polite-config uses the Poetry dependency manager. Poetry must be installed and available on the command line.
To install:
poetry install
Tests
A test suite is provided with the source code that uses pytest.
Install the testing dependencies:
poetry install --with test
Additional tests are available for the plugins to dtocean-core. Enable these
tests by installing the test-extras group:
poetry install --with test --with test-extras
Run the tests:
poetry run pytest
Code quality can also be audited using the ruff and pyright tools. Install the dependencies:
poetry install --with audit
Run the audit:
poetry run ruff
poetry run pyright src
The above tests can be run across all compatible Python versions using tox and tox-uv. To install and run:
poetry install --with tox
poetry run tox
Contributing
Please see the dtocean GitHub repository for contributing guidelines.
License
1 maintainer
Metadata
1 maintainer
Release files for dtocean-docs 4.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| dtocean_docs-4.0.7-cp314-cp314-win_amd64.whl | CPython 3.14 | CPython 3.14 | Windows x86-64 | Details |
| dtocean_docs-4.0.7-cp314-cp314-manylinux_2_39_x86_64.whl | CPython 3.14 | CPython 3.14 | Linux glibc 2.39+ x86-64 | Details |
| dtocean_docs-4.0.7-cp313-cp313-win_amd64.whl | CPython 3.13 | CPython 3.13 | Windows x86-64 | Details |
| dtocean_docs-4.0.7-cp313-cp313-manylinux_2_39_x86_64.whl | CPython 3.13 | CPython 3.13 | Linux glibc 2.39+ x86-64 | Details |
| dtocean_docs-4.0.7-cp312-cp312-win_amd64.whl | CPython 3.12 | CPython 3.12 | Windows x86-64 | Details |
| dtocean_docs-4.0.7-cp312-cp312-manylinux_2_39_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.39+ x86-64 | Details |
Total release size: 47.0 MB
Release files / dtocean_docs-4.0.7-cp314-cp314-win_amd64.whl
| Download URL | dtocean_docs-4.0.7-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 7.9 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
86a70b7f72506fa51edbb9c711ea072193fe7c53f535bacee0aecf15420a9921
|
|
BLAKE2b-256 checksum How to use checksums |
5d50e7b787bc858d74d6ae58ffdaae5724d5d2743da2123307bd472267655ccd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 22, 2026.
Transparency logRelease files / dtocean_docs-4.0.7-cp314-cp314-manylinux_2_39_x86_64.whl
| Download URL | dtocean_docs-4.0.7-cp314-cp314-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.14 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
d5e86599aee8df4162c86db05774deb52559f3f31cb01045fe00c5130bc651ed
|
|
BLAKE2b-256 checksum How to use checksums |
df10c891cc5ec21f8b28f255a606a499abd5ab03b94e8192b52335e8b7dd2103
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 22, 2026.
Transparency logRelease files / dtocean_docs-4.0.7-cp313-cp313-win_amd64.whl
| Download URL | dtocean_docs-4.0.7-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
5c6f6f29b5202c2474360d71483ce6ce615997a85fb7d343ba7d323a1bc53580
|
|
BLAKE2b-256 checksum How to use checksums |
1887a767f694d9298e22b56e901aaa9e58bd1a83f68feea107b9f1d6f1e2c47b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 22, 2026.
Transparency logRelease files / dtocean_docs-4.0.7-cp313-cp313-manylinux_2_39_x86_64.whl
| Download URL | dtocean_docs-4.0.7-cp313-cp313-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.13 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
2e3705f5078b09c55b9525a46ccbb894ec0454d6a0974d612fe4f6a7c0fbc8e8
|
|
BLAKE2b-256 checksum How to use checksums |
41271ae50efcd2df213c5d8693496126c125889e033ce9a4b23bae7495a1754e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 22, 2026.
Transparency logRelease files / dtocean_docs-4.0.7-cp312-cp312-win_amd64.whl
| Download URL | dtocean_docs-4.0.7-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
607abbcd28d6600f2486da0cf764d938b31ec23b4c14115e4733f913c6c2dd99
|
|
BLAKE2b-256 checksum How to use checksums |
36b8ef1818df146d085dca6be2cbadd33eb1d5b0f1a28b715169bb4dde58c67e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 22, 2026.
Transparency logRelease files / dtocean_docs-4.0.7-cp312-cp312-manylinux_2_39_x86_64.whl
| Download URL | dtocean_docs-4.0.7-cp312-cp312-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.12 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
abbc83e33f1d59ea2a36da0fcc7ea5b975a603f2fff55e913d88b70ab45c418a
|
|
BLAKE2b-256 checksum How to use checksums |
cb2c7ee84dbaf5eb8557551c98f47cb18e8351da5b302525569872478b9b9b15
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 22, 2026.
Transparency log
