summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordrebs <drebs@riseup.net>2017-09-15 09:29:05 -0300
committerdrebs <drebs@riseup.net>2017-09-15 09:29:05 -0300
commitf29abe28bd778838626d12fcabe3980a8ce4fa8c (patch)
treea986c4e16d8d261c9f7385ee2d2a0c76e5bc6b27
parent6ccb3dd07b401f9caa902e4690486c325e9aca52 (diff)
[doc] move environment variables to reference section
-rw-r--r--docs/client.rst4
-rw-r--r--docs/environment_variables.rst20
-rw-r--r--docs/reference.rst5
-rw-r--r--docs/reference/attachments.rst (renamed from docs/attachments.rst)0
-rw-r--r--docs/reference/environment_variables.rst19
-rw-r--r--docs/reference/incoming_box.rst (renamed from docs/incoming_box.rst)0
6 files changed, 22 insertions, 26 deletions
diff --git a/docs/client.rst b/docs/client.rst
index 7efabd6f..3befd69c 100644
--- a/docs/client.rst
+++ b/docs/client.rst
@@ -7,7 +7,3 @@ migrated here in the future.
You can also take a look at :ref:`client-side-code-api` and
:ref:`client-side-attachments-api` for information on the API.
-
-.. toctree::
-
- environment_variables
diff --git a/docs/environment_variables.rst b/docs/environment_variables.rst
deleted file mode 100644
index 8b976826..00000000
--- a/docs/environment_variables.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-Environment Variables
-=====================
-
-Some environment variables affect the behaviour of Soledad:
-
-============================== ============= =================================
-variable affects description
-============================== ============= =================================
-``SOLEDAD_HTTP_PERSIST`` client persist HTTP connections.
-``SOLEDAD_SERVER_CONFIG_FILE`` server use this configuration file
- instead of the default one.
-``LOCAL_SERVICES_PORT`` server which port to use for local
- TCP services.
-``HTTPS_PORT`` server which port to use for public
- HTTPS services.
-``SOLEDAD_USE_PYTHON_LOGGING`` client/server use python logging instead of
- twisted's logger.
-``SOLEDAD_LOG_TO_STDOUT`` client/server log to standard output.
-============================== ============= =================================
-
diff --git a/docs/reference.rst b/docs/reference.rst
index 063c46dd..8203d9aa 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -6,5 +6,6 @@ This page gathers reference documentation to understanding the internals of Sole
.. toctree::
:maxdepth: 1
- attachments
- incoming_box
+ reference/environment_variables
+ reference/attachments
+ reference/incoming_box
diff --git a/docs/attachments.rst b/docs/reference/attachments.rst
index 9561edcf..9561edcf 100644
--- a/docs/attachments.rst
+++ b/docs/reference/attachments.rst
diff --git a/docs/reference/environment_variables.rst b/docs/reference/environment_variables.rst
new file mode 100644
index 00000000..bfd155ee
--- /dev/null
+++ b/docs/reference/environment_variables.rst
@@ -0,0 +1,19 @@
+Environment Variables
+=====================
+
+Some environment variables affect the behaviour of Soledad:
+
+============================== =============== =================================
+variable affects description
+============================== =============== =================================
+``SOLEDAD_HTTP_PERSIST`` client persist HTTP connections.
+``SOLEDAD_USE_PYTHON_LOGGING`` client / server use python logging instead of
+ twisted's logger.
+``SOLEDAD_LOG_TO_STDOUT`` client / server log to standard output.
+``SOLEDAD_SERVER_CONFIG_FILE`` server use this configuration file
+ instead of the default one.
+``LOCAL_SERVICES_PORT`` server which port to use for local
+ TCP services.
+``HTTPS_PORT`` server which port to use for public
+ HTTPS services.
+============================== =============== =================================
diff --git a/docs/incoming_box.rst b/docs/reference/incoming_box.rst
index cbea6d32..cbea6d32 100644
--- a/docs/incoming_box.rst
+++ b/docs/reference/incoming_box.rst