dtocean-docs 4.0.1

Offline DTOcean documentation for dtocean-app

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

GPL-3.0