Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-11-21 04:46:31 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
Files
4c2997dbd6c3077bfc3df5ef208bb7386ed36d34
EOS/docs/_generated/configserver.md
Bobby Noelte 7bf9dd723e
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
Details
pre-commit / pre-commit (push) Has been cancelled
Details
Run Pytest on Pull Request / test (push) Has been cancelled
Details
docker-build / build (push) Has been cancelled
Details
docker-build / merge (push) Has been cancelled
Details
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
Details
chore: improve doc generation and test (#762) 
Improve documentation generation and add tests for documentation.
Extend sphinx by todo directive.

The configuration table is now split into several tables. The test
is adapted accordingly.

There is a new test that checks the docstrings to be compliant to the
RST format as used by sphinx to create the documentation. We can not
use Markdown in docstrings. The docstrings are adapted accordingly.

An additional test checks that the documentation can be build with sphinx.
This test takes very long is only enabled in full run (aka. ci) mode.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-11-13 22:53:46 +01:00

1.5 KiB
Raw Blame History

Server Configuration

:::{table} server :widths: 10 20 10 5 5 30 :align: left

Name Environment Variable Type Read-Only Default Description
eosdash_host EOS_SERVER__EOSDASH_HOST Optional[str] rw None EOSdash server IP address. Defaults to EOS server IP address.
eosdash_port EOS_SERVER__EOSDASH_PORT Optional[int] rw None EOSdash server IP port number. Defaults to EOS server IP port number + 1.
host EOS_SERVER__HOST Optional[str] rw 127.0.0.1 EOS server IP address. Defaults to 127.0.0.1.
port EOS_SERVER__PORT Optional[int] rw 8503 EOS server IP port number. Defaults to 8503.
startup_eosdash EOS_SERVER__STARTUP_EOSDASH Optional[bool] rw True EOS server to start EOSdash server. Defaults to True.
verbose EOS_SERVER__VERBOSE Optional[bool] rw False Enable debug output
:::

Example Input/Output

   {
       "server": {
           "host": "127.0.0.1",
           "port": 8503,
           "verbose": false,
           "startup_eosdash": true,
           "eosdash_host": "127.0.0.1",
           "eosdash_port": 8504
       }
   }