Commit fab7c617 authored by Matt Traudt's avatar Matt Traudt
Browse files

Docs: move config info from readme to docs

parent 9be92624
......@@ -78,25 +78,15 @@ license. See [`LICENSE.md`](/LICENSE.md) for more information.
See more documentation in [/docs/source/](/docs/source/)
## Configuration
**XXX: replace the above sentence with a link to the documentation website**
Sbws has two config files it reads.
### Build HTML documentation
It first reads the config file containing the default values for almost all
options. If you installed sbws in a virtual environment located at /tmp/venv, then
you will probably find the `config.default.ini` in a place such as
`/tmp/venv/lib/python3.5/site-packages/sbws/`
**You should never edit this file**. You can also click on
[this link](/sbws/config.default.ini) to see the default config file if you're
reading this on GitHub.
Sbws then reads your custom config file. By default, after running `sbws init`,
it is located in `~/.sbws/config.ini`. A configuration option in this file
overwrites the default file found in the default file.
pip install -e .[doc]
cd docs
make html
**No other configuration files are read.** The only files that are read are the
`config.default.ini` file located in a place the user shouldn't touch, and the
`config.ini` in their `.sbws` directory.
The generated HTML will be in `docs/build/`.
## The `.sbws` directory
......@@ -114,14 +104,6 @@ In this directory you will find
them into this directory. Other sbws commands (such as generate and stats)
read results from the files in this directory.
## Build HTML documentation
pip install -e .[doc]
cd docs
make html
The generated HTML will be in [/docs/build/](/docs/build/)
## Running tests
Make sure you have test dependencies installed. From within the top level
......
../../sbws/config.default.ini
\ No newline at end of file
[paths]
datadir = ${sbws_home}/datadir
sbws_home = /home/user/.sbws
[general]
log_level = notice
[client]
nickname = IDidntEditTheSBWSConfig
Simple Bandwidth Scanner Configuration Files
============================================
Sbws has two config files it reads.
It first reads the config file containing the default values for almost all
options. If you installed sbws in a virtual environment located at /tmp/venv,
then you will probably find the ``config.default.ini`` in a place such as
``/tmp/venv/lib/python3.5/site-packages/sbws/`` **You should never edit this
file**. The contents of this default config file can be found :ref:`at the
bottom of this page <default-config>`.
Sbws then reads your custom config file. By default, after running ``sbws
init``, it is located in ``~/.sbws/config.ini``. A configuration option in this
file overwrites the default file found in the default file.
After running ``sbws init``, your ``~/.sbws/config.ini`` might look like this.
.. _init-config:
.. literalinclude:: config.ini
:caption: Example ~/.sbws/config.ini
**No other configuration files are read.** The only files that are read are the
``config.default.ini`` file located in a place the user shouldn't touch, and
the ``config.ini`` in their ``.sbws`` directory.
.. _default-config:
Default Config
--------------
.. literalinclude:: config.default.ini
:caption: config.default.ini
......@@ -12,6 +12,7 @@ Welcome to Simple Bandwidth Scanner's documentation!
:caption: Contents:
specification
config
INSTALL
DEPLOY
README
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment